Appearance

List Invoices ​

Endpoint ​

http
GET /unified/accounting/invoices
Integrations supported
  • QuickBooks
  • Xero
Partial response integrations

For partial response integrations, you will need to fetch the individual resource using the "get" endpoint to get the full response object.

  • Xero

Query parameters ​

integrated_account_id
string · uuid
REQUIRED · The ID of the integrated account to use for the request.
Example: 62f44730-dd91-461e-bd6a-aedd9e0ad79d
invoice_type
string
The type of the invoice
All possible enum values:
  • bill
  • invoice
Required in
  • QuickBooks
Supported in
  • Xero
created_at
string
This represents the date when the invoice was created
Supported in
  • QuickBooks
  • Xero
updated_at
string
This represents the date when the invoice was updated
Supported in
  • QuickBooks
  • Xero
number
string
The number of the invoice
Supported in
  • Xero
currency
string
The currency of the invoice
Supported in
  • Xero
status
string
The status of the invoice
All possible enum values:
  • authorised
  • deleted
  • draft
  • paid
  • submitted
  • voided
Supported in
  • Xero

Response Body ​

result
object[]
List of Invoices
id
string
REQUIRED · The unique identifier for invoices
Supported in
  • QuickBooks
  • Xero
type
string
The type of the invoice
All possible enum values:
  • bill
  • invoice
Supported in
  • QuickBooks
  • Xero
contact
object
The contact for whom the invoice is raised.
Supported in
  • QuickBooks
  • Xero
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
Supported in
  • QuickBooks
  • Xero
issue_date
string
The issue date of the invoice
Supported in
  • Xero
due_date
string
The due date of the invoice
Supported in
  • QuickBooks
  • Xero
paid_on_date
string
The paid on date of the invoice
memo
string
The private note of the invoice
Supported in
  • QuickBooks
company
string
The company the invoice belongs to
currency
string
The currency of the invoice
Supported in
  • QuickBooks
  • Xero
exchange_rate
number
The exchange rate of the invoice
Supported in
  • Xero
total_discount
number
The total discount of the invoice
sub_total
number
The sub total of the invoice
Supported in
  • QuickBooks
  • Xero
total_tax_amount
number
The total tax amount of the invoice
Supported in
  • QuickBooks
  • Xero
balance
number
The remaining balance of the invoice
Supported in
  • QuickBooks
  • Xero
payments
string[]
List of payment IDs associated with the invoice
Supported in
  • Xero
line_items
object[]
The line items of the invoice
Supported in
  • QuickBooks
  • Xero
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
Supported in
  • Xero
created_at
string
This represents the date when the invoice was created
Supported in
  • QuickBooks
  • Xero
updated_at
string
This represents the date when the invoice was updated
Supported in
  • QuickBooks
  • Xero
remote_data
object
Raw data returned from the remote API call.
next_cursor
string
The cursor to use for the next page of results. Pass this value as `next_cursor` in the query parameter in the next request to get the next page of results.