Appearance

List Invoices ​

Endpoint ​

http
GET /unified/accounting/invoices
Integrations supported
  • FreeAgent
  • 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.

  • FreeAgent
  • Xero

Query parameters ​

Refer Specifying query parameters in Truto APIs

integrated_account_id
string · uuid
REQUIRED · 

The ID of the integrated account to use for the request.

Example: 62f44730-dd91-461e-bd6a-aedd9e0ad79d
truto_response_format
string

The format of the response.

  • unified will return the response with unified mappings applied.
  • raw will return the raw response from the remote API.
  • normalized will apply the unified mappings and return the data in a normalized format.

Defaults to unified.

All possible enum values:
  • unified
  • raw
  • normalized
Example: unified
truto_key_by
string

By default the result attribute is an array of objects. This parameter allows you to specify a field in each result objects to use as key, which transforms the result array into an object with the array items keyed by the field. This is useful for when you want to use the result as a lookup table.

Example: id
truto_ignore_limit
boolean

Ignores the limit query parameter.

truto_ignore_remote_data
boolean

Excludes the remote_data attribute from the response.

truto_exclude_fields
array

Array of fields to exclude from the response.

Example: truto_exclude_fields[]=id&truto_exclude_fields[]=name
remote_query
object

Query parameters to pass to the underlying API without any transformations. Refer this guide to see how to structure the query parameters.

Example: remote_query[foo]=bar
contact
object

The contact for whom the invoice is raised.

Supported in
  • QuickBooks
id
string

The unique identifier for the contact

type
string

The type of the contact - vendor or customer.

invoice_type
string

The type of the invoice

All possible enum values:
  • bill
  • invoice
Required in
  • QuickBooks
Supported in
  • Xero
created_at
string · date-time

This represents the date when the invoice was created

Supported in
  • QuickBooks
  • Xero
updated_at
string · date-time

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
type
string

The type of the invoice

All possible enum values:
  • bill
  • invoice
Supported in
  • FreeAgent

Response Body ​

result
object[]

List of Invoices

id
string
REQUIRED · 

The unique identifier for invoices

Supported in
  • FreeAgent
  • QuickBooks
  • Xero
type
string

The type of the invoice

All possible enum values:
  • bill
  • invoice
Supported in
  • FreeAgent
  • QuickBooks
  • Xero
contact
object

The contact for whom the invoice is raised.

Supported in
  • FreeAgent
  • 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
  • FreeAgent
  • QuickBooks
  • Xero
issue_date
string · date-time

The issue date of the invoice

Supported in
  • FreeAgent
  • Xero
due_date
string · date-time

The due date of the invoice

Supported in
  • FreeAgent
  • QuickBooks
  • Xero
paid_on_date
string · date-time

The paid on date of the invoice

Supported in
  • FreeAgent
memo
string

The private note of the invoice

Supported in
  • FreeAgent
  • QuickBooks
company
string

The company the invoice belongs to

Supported in
  • FreeAgent
currency
string

The currency of the invoice

Supported in
  • FreeAgent
  • QuickBooks
  • Xero
exchange_rate
number

The exchange rate of the invoice

Supported in
  • FreeAgent
  • Xero
total_discount
number

The total discount of the invoice

Supported in
  • FreeAgent
sub_total
number

The sub total of the invoice

Supported in
  • FreeAgent
  • 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
  • FreeAgent
  • 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
  • FreeAgent
  • Xero
created_at
string · date-time

This represents the date when the invoice was created

Supported in
  • FreeAgent
  • QuickBooks
  • Xero
updated_at
string · date-time

This represents the date when the invoice was updated

Supported in
  • FreeAgent
  • 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.