Appearance

Download Invoices ​

Endpoint ​

http
POST /unified/accounting/invoices/download
Integrations supported
  • 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 returns the response with unified mappings applied.
  • raw returns the unprocessed, raw response from the remote API.
  • normalized applies the unified mappings and returns the data in a normalized format.
  • stream returns the response as a stream, which is ideal for transmitting large datasets, files, or binary data. Using streaming mode helps to efficiently handle large payloads or real-time data flows without requiring the entire data to be buffered in memory.
  • debug returns the final unified result alongside raw remote fetch information. The response is an envelope containing result (identical to unified mode output) and debug (with requestUrl, requestOptions, data, responseHeaders, and for list operations: nextCursor, isLooping, isEmptyResult, resultCount). debug is null for static responses or when truto_skip_api_call=true.

Defaults to unified.

All possible enum values:
  • unified
  • raw
  • normalized
  • stream
  • debug
Example: unified
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
file_url
string

The URL of the invoice you want to download.

Required in
  • Xero

Request Body ​

Refer Writing data using Unified APIs

remote_data
object

Any additional data that should be passed as part of the request body. This data is not transformed by Truto and is passed as is to the remote API.

Response Body ​

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.

References: Contacts → id
id
string

The unique identifier for the contact

name
string

The name of 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

References: CompanyInfo → id
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

References: Payments → id
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

urls
object[]

The invoice URLs

url
string

The invoice URL

type
string

Type of invoice URL

tracking_categories
object[]

Tracking categories of the invoices

References: TrackingCategories → id
id
string

The ID of the tracking category

name
string

The name of the tracking category

option
string

The option of the tracking category

remote_data
object

Raw data returned from the remote API call.