Skip to content

Relationships

Schema relationships
graph LR
    Invoices -->|"contact"| Contacts
    Invoices -->|"company"| CompanyInfo
    Invoices -->|"payments"| Payments
    Invoices -->|"tracking_categories"| TrackingCategories

Properties

idstring
required·

The unique identifier for invoices

balancenumber

The remaining balance of the invoice

companystring

The company the invoice belongs to

References: CompanyInfo → id
contactobject

The contact for whom the invoice is raised.

References: Contacts → id
idstring

The unique identifier for the contact

namestring

The name of the contact

typestring

The type of the contact - vendor or customer.

created_atstring · date-time

This represents the date when the invoice was created

currencystring

The currency of the invoice

due_datestring · date-time

The due date of the invoice

exchange_ratenumber

The exchange rate of the invoice

issue_datestring · date-time

The issue date of the invoice

line_itemsobject[]

The line items of the invoice

accountstring

The ID of the account

currencystring

The currency of the line item

descriptionstring

The description of the line item

exchange_ratenumber

The exchange rate of the currency for the line item

idstring

The unique identifier for line item

itemstring

The ID of the item

namestring

The name of the line item

quantitynumber

The quantity of the line item

tax_ratestring

The ID of the tax rate

total_line_amountnumber

The total line amount of the line item.

tracking_categoriesobject[]

Tracking categories of the line item

3 properties
idstring

The ID of the tracking category

namestring

The name of the tracking category

optionstring

The option of the tracking category

typestring

The type of the line item

unit_pricenumber

The unit price of the line item

memostring

The private note of the invoice

numberstring

The number of the invoice

paid_on_datestring · date-time

The paid on date of the invoice

paymentsstring[]

List of payment IDs associated with the invoice

References: Payments → id
remote_dataRecord<string, any>

Raw data returned from the remote API call.

statusstring

The status of the invoice

Possible values:
draftsubmitteddeletedauthorisedpaidvoided
sub_totalnumber

The sub total of the invoice

total_discountnumber

The total discount of the invoice

total_tax_amountnumber

The total tax amount of the invoice

tracking_categoriesobject[]

Tracking categories of the invoices

idstring

The ID of the tracking category

namestring

The name of the tracking category

optionstring

The option of the tracking category

typestring

The type of the invoice

Possible values:
billinvoice
updated_atstring · date-time

This represents the date when the invoice was updated