Skip to content

Latest commit

 

History

History
35 lines (32 loc) · 22.6 KB

creditnoteinput.md

File metadata and controls

35 lines (32 loc) · 22.6 KB

CreditNoteInput

Fields

Field Type Required Description Example
Number *string ➖ Credit note number. OIT00546
Customer *components.LinkedCustomerInput ➖ The customer this entity is linked to.
CompanyID *string ➖ The company or subsidiary id the transaction belongs to 12345
Currency *components.Currency ➖ Indicates the associated currency for an amount of money. Values correspond to ISO 4217. USD
CurrencyRate *float64 ➖ Currency Exchange Rate at the time entity was recorded/generated. 0.69
TaxInclusive *bool ➖ Amounts are including tax true
SubTotal *float64 ➖ Sub-total amount, normally before tax. 27500
TotalAmount float64 ✔️ Amount of transaction 49.99
TotalTax *float64 ➖ Total tax amount applied to this invoice. 2500
TaxCode *string ➖ Applicable tax id/code override if tax is not supplied on a line item basis. 1234
Balance *float64 ➖ The balance reflecting any payments made against the transaction. 27500
RemainingCredit *float64 ➖ Indicates the total credit amount still available to apply towards the payment. 27500
Status *components.CreditNoteStatus ➖ Status of credit notes authorised
Reference *string ➖ Optional reference message ie: Debit remittance detail. 123456
DateIssued *time.Time ➖ Date credit note issued - YYYY:MM::DDThh:mm:ss.sTZD 2021-05-01T12:00:00.000Z
DatePaid *time.Time ➖ Date credit note paid - YYYY:MM::DDThh:mm:ss.sTZD 2021-05-01T12:00:00.000Z
Type *components.CreditNoteType ➖ Type of payment accounts_receivable_credit
Account *components.LinkedLedgerAccountInput ➖ N/A
LineItems []components.InvoiceLineItemInput ➖ N/A
Allocations []components.AllocationInput ➖ N/A
Note *string ➖ Optional note to be associated with the credit note. Some notes about this credit note
Terms *string ➖ Optional terms to be associated with the credit note. Some terms about this credit note
BillingAddress *components.Address ➖ N/A
ShippingAddress *components.Address ➖ N/A
TrackingCategories []components.LinkedTrackingCategory ➖ A list of linked tracking categories.
CustomFields []components.CustomField ➖ N/A
RowVersion *string ➖ A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object. 1-12345
PassThrough []components.PassThroughBody ➖ The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.