Skip to content

Invoices Object



id
string
REQUIRED · 

The unique identifier for invoices

type
string

The type of the invoice

All possible enum values:
  • bill
  • invoice
contact
object

The contact for whom the invoice is raised.

id
string

The unique identifier for the contact

type
string

The type of the contact - vendor or customer.

number
string

The number of the invoice

issue_date
string · date-time

The issue date of the invoice

due_date
string · date-time

The due date of the invoice

paid_on_date
string · date-time

The paid on date of the invoice

memo
string

The private note of the invoice

company
string

The company the invoice belongs to

currency
string

The currency of the invoice

exchange_rate
number

The exchange rate of the invoice

total_discount
number

The total discount of the invoice

sub_total
number

The sub total of the invoice

total_tax_amount
number

The total tax amount of the invoice

balance
number

The remaining balance of the invoice

payments
string[]

List of payment IDs associated with the invoice

line_items
object[]

The line items of the invoice

id
string

The unique identifier for line item

name
string

The name of the line item

description
string

The description of the line item

item
string

The ID of the item

account
string

The ID of the account

quantity
number

The quantity of the line item

unit_price
number

The unit price of the line item

tax_rate
string

The ID of the tax rate

total_line_amount
number

The total line amount of the line item.

type
string

The type of the line item

tracking_categories
object[]

Tracking categories of the line item

id
string

The ID of the tracking category

name
string

The name of the tracking category

option
string

The option of the tracking category

currency
string

The currency of the line item

exchange_rate
number

The exchange rate of the currency for the line item

status
string

The status of the invoice

All possible enum values:
  • draft
  • submitted
  • deleted
  • authorised
  • paid
  • voided
created_at
string · date-time

This represents the date when the invoice was created

updated_at
string · date-time

This represents the date when the invoice was updated

remote_data
object

Raw data returned from the remote API call.