id |
?string |
➖ |
A unique identifier for an object. |
12345 |
downstreamId |
?string |
➖ |
The third-party API ID of original entity |
12345 |
displayId |
?string |
➖ |
Id to be displayed. |
123456 |
billNumber |
?string |
➖ |
Reference to supplier bill number |
10001 |
supplier |
?Components\LinkedSupplier |
➖ |
The supplier 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 |
?Components\Currency |
➖ |
Indicates the associated currency for an amount of money. Values correspond to ISO 4217. |
USD |
currencyRate |
?float |
➖ |
Currency Exchange Rate at the time entity was recorded/generated. |
0.69 |
taxInclusive |
?bool |
➖ |
Amounts are including tax |
true |
billDate |
\DateTime |
➖ |
Date bill was issued - YYYY-MM-DD. |
2020-09-30 |
dueDate |
\DateTime |
➖ |
The due date is the date on which a payment is scheduled to be received - YYYY-MM-DD. |
2020-10-30 |
paidDate |
\DateTime |
➖ |
The paid date is the date on which a payment was sent to the supplier - YYYY-MM-DD. |
2020-10-30 |
poNumber |
?string |
➖ |
A PO Number uniquely identifies a purchase order and is generally defined by the buyer. The buyer will match the PO number in the invoice to the Purchase Order. |
90000117 |
reference |
?string |
➖ |
Optional reference identifier for the transaction. |
INV-2024-001 |
lineItems |
array<Components\BillLineItem> |
➖ |
N/A |
|
terms |
?string |
➖ |
Terms of payment. |
Net 30 days |
termsId |
?string |
➖ |
The ID of the payment terms |
12345 |
balance |
?float |
➖ |
Balance of bill due. |
27500 |
deposit |
?float |
➖ |
Amount of deposit made to this bill. |
0 |
subTotal |
?float |
➖ |
Subtotal amount, normally before tax. |
250 |
totalTax |
?float |
➖ |
Total tax amount applied to this transaction. |
25 |
total |
?float |
➖ |
Total amount of bill, including tax. |
27500 |
taxCode |
?string |
➖ |
Applicable tax id/code override if tax is not supplied on a line item basis. |
1234 |
notes |
?string |
➖ |
N/A |
Some notes about this bill. |
status |
?Components\BillStatus |
➖ |
Invoice status |
draft |
ledgerAccount |
?Components\LinkedLedgerAccount |
➖ |
N/A |
|
paymentMethod |
?string |
➖ |
Payment method used for the transaction, such as cash, credit card, bank transfer, or check |
cash |
channel |
?string |
➖ |
The channel through which the transaction is processed. |
email |
language |
?string |
➖ |
language code according to ISO 639-1. For the United States - EN |
EN |
accountingByRow |
?bool |
➖ |
Indicates if accounting by row is used (true) or not (false). Accounting by row means that a separate ledger transaction is created for each row. |
false |
bankAccount |
?Components\BankAccount |
➖ |
N/A |
|
discountPercentage |
?float |
➖ |
Discount percentage applied to this transaction. |
5.5 |
templateId |
?string |
➖ |
Optional bill template |
123456 |
approvedBy |
?string |
➖ |
The user who approved the bill |
John Doe |
amortizationType |
?Components\AmortizationType |
➖ |
Type of amortization |
|
taxMethod |
?string |
➖ |
Method of tax calculation |
Due to supplier |
documentReceived |
?bool |
➖ |
Whether the document has been received |
true |
sourceDocumentUrl |
?string |
➖ |
URL link to a source document - shown as 'Go to [appName]' in the downstream app. Currently only supported for Xero. |
https://www.invoicesolution.com/bill/123456 |
paymentAllocations |
array<Components\LinkedPaymentAllocations> |
➖ |
A list of linked payment allocations. |
|
trackingCategories |
array<Components\LinkedTrackingCategory> |
➖ |
A list of linked tracking categories. |
|
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 |
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 |
customFields |
array<Components\CustomField1|Components\CustomField2> |
➖ |
N/A |
|
customMappings |
array<string, mixed> |
➖ |
When custom mappings are configured on the resource, the result is included here. |
|
passThrough |
array<Components\PassThroughBody> |
➖ |
The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources. |
|
accountingPeriod |
?string |
➖ |
Accounting period |
01-24 |
attachments |
array<Components\LinkedAttachment> |
➖ |
N/A |
|