id |
str |
✔️ |
Unique identifier representing the entity |
123456 |
number |
OptionalNullable[str] |
➖ |
Credit note number. |
OIT00546 |
customer |
OptionalNullable[models.LinkedCustomer] |
➖ |
The customer this entity is linked to. |
|
company_id |
OptionalNullable[str] |
➖ |
The company ID the transaction belongs to |
12345 |
location_id |
OptionalNullable[str] |
➖ |
The ID of the location |
12345 |
department_id |
OptionalNullable[str] |
➖ |
The ID of the department |
12345 |
currency |
OptionalNullable[models.Currency] |
➖ |
Indicates the associated currency for an amount of money. Values correspond to ISO 4217. |
USD |
currency_rate |
OptionalNullable[float] |
➖ |
Currency Exchange Rate at the time entity was recorded/generated. |
0.69 |
tax_inclusive |
OptionalNullable[bool] |
➖ |
Amounts are including tax |
true |
sub_total |
OptionalNullable[float] |
➖ |
Sub-total amount, normally before tax. |
27500 |
total_amount |
float |
✔️ |
Amount of transaction |
49.99 |
total_tax |
OptionalNullable[float] |
➖ |
Total tax amount applied to this invoice. |
2500 |
tax_code |
OptionalNullable[str] |
➖ |
Applicable tax id/code override if tax is not supplied on a line item basis. |
1234 |
balance |
OptionalNullable[float] |
➖ |
The balance reflecting any payments made against the transaction. |
27500 |
remaining_credit |
OptionalNullable[float] |
➖ |
Indicates the total credit amount still available to apply towards the payment. |
27500 |
status |
Optional[models.CreditNoteStatus] |
➖ |
Status of credit notes |
authorised |
reference |
OptionalNullable[str] |
➖ |
Optional reference message ie: Debit remittance detail. |
123456 |
date_issued |
date |
➖ |
Date credit note issued - YYYY:MM::DDThh:mm:ss.sTZD |
2021-05-01T12:00:00.000Z |
date_paid |
date |
➖ |
Date credit note paid - YYYY:MM::DDThh:mm:ss.sTZD |
2021-05-01T12:00:00.000Z |
type |
Optional[models.CreditNoteType] |
➖ |
Type of payment |
accounts_receivable_credit |
account |
OptionalNullable[models.LinkedLedgerAccount] |
➖ |
N/A |
|
line_items |
List[models.InvoiceLineItem] |
➖ |
N/A |
|
allocations |
List[models.Allocation] |
➖ |
N/A |
|
note |
OptionalNullable[str] |
➖ |
Optional note to be associated with the credit note. |
Some notes about this credit note |
terms |
OptionalNullable[str] |
➖ |
Optional terms to be associated with the credit note. |
Some terms about this credit note |
terms_id |
OptionalNullable[str] |
➖ |
The ID of the payment terms |
12345 |
billing_address |
Optional[models.Address] |
➖ |
N/A |
|
shipping_address |
Optional[models.Address] |
➖ |
N/A |
|
tracking_categories |
List[Nullable[models.LinkedTrackingCategory]] |
➖ |
A list of linked tracking categories. |
|
custom_mappings |
Dict[str, Any] |
➖ |
When custom mappings are configured on the resource, the result is included here. |
|
custom_fields |
List[models.CustomField] |
➖ |
N/A |
|
row_version |
OptionalNullable[str] |
➖ |
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 |
updated_by |
OptionalNullable[str] |
➖ |
The user who last updated the object. |
12345 |
created_by |
OptionalNullable[str] |
➖ |
The user who created the object. |
12345 |
updated_at |
date |
➖ |
The date and time when the object was last updated. |
2020-09-30T07:43:32.000Z |
created_at |
date |
➖ |
The date and time when the object was created. |
2020-09-30T07:43:32.000Z |
pass_through |
List[models.PassThroughBody] |
➖ |
The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources. |
|