Id |
string |
✔️ |
Unique identifier representing the entity |
123456 |
Number |
string |
➖ |
Credit note number. |
OIT00546 |
Customer |
LinkedCustomer |
➖ |
The customer this entity is linked to. |
|
CompanyId |
string |
➖ |
The company ID the transaction belongs to |
12345 |
LocationId |
string |
➖ |
The ID of the location |
12345 |
DepartmentId |
string |
➖ |
The ID of the department |
12345 |
Currency |
Currency |
➖ |
Indicates the associated currency for an amount of money. Values correspond to ISO 4217. |
USD |
CurrencyRate |
double |
➖ |
Currency Exchange Rate at the time entity was recorded/generated. |
0.69 |
TaxInclusive |
bool |
➖ |
Amounts are including tax |
true |
SubTotal |
double |
➖ |
Sub-total amount, normally before tax. |
27500 |
TotalAmount |
double |
✔️ |
Amount of transaction |
49.99 |
TotalTax |
double |
➖ |
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 |
double |
➖ |
The balance reflecting any payments made against the transaction. |
27500 |
RemainingCredit |
double |
➖ |
Indicates the total credit amount still available to apply towards the payment. |
27500 |
Status |
CreditNoteStatus |
➖ |
Status of credit notes |
authorised |
Reference |
string |
➖ |
Optional reference message ie: Debit remittance detail. |
123456 |
DateIssued |
DateTime |
➖ |
Date credit note issued - YYYY:MM::DDThh:mm:ss.sTZD |
2021-05-01T12:00:00.000Z |
DatePaid |
DateTime |
➖ |
Date credit note paid - YYYY:MM::DDThh:mm:ss.sTZD |
2021-05-01T12:00:00.000Z |
Type |
CreditNoteType |
➖ |
Type of payment |
accounts_receivable_credit |
Account |
LinkedLedgerAccount |
➖ |
N/A |
|
LineItems |
List<InvoiceLineItem> |
➖ |
N/A |
|
Allocations |
List<Allocation> |
➖ |
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 |
TermsId |
string |
➖ |
The ID of the payment terms |
12345 |
BillingAddress |
Address |
➖ |
N/A |
|
ShippingAddress |
Address |
➖ |
N/A |
|
TrackingCategories |
List<LinkedTrackingCategory> |
➖ |
A list of linked tracking categories. |
|
CustomMappings |
Dictionary<String, object> |
➖ |
When custom mappings are configured on the resource, the result is included here. |
|
CustomFields |
List<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 |
UpdatedBy |
string |
➖ |
The user who last updated the object. |
12345 |
CreatedBy |
string |
➖ |
The user who created the object. |
12345 |
UpdatedAt |
DateTime |
➖ |
The date and time when the object was last updated. |
2020-09-30T07:43:32.000Z |
CreatedAt |
DateTime |
➖ |
The date and time when the object was created. |
2020-09-30T07:43:32.000Z |
PassThrough |
List<PassThroughBody> |
➖ |
The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources. |
|