Skip to content
POST /unified/accounting/invoices/download

Query Parameters

Refer Specifying query parameters in Truto APIs

file_urlstring

The URL of the invoice you want to download.

1 supported1 required
Xero
required
Show Truto-specific parameters
integrated_account_idstring · uuid
required·

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

Example: 62f44730-dd91-461e-bd6a-aedd9e0ad79d
truto_response_formatstring

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.

Example: unified
Possible values:
unifiedrawnormalizedstreamdebug
truto_ignore_remote_databoolean

Excludes the remote_data attribute from the response.

truto_exclude_fieldsstring[]

Array of fields to exclude from the response.

Example: truto_exclude_fields[]=id&truto_exclude_fields[]=name
remote_queryRecord<string, any>

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

Request Body

Refer Writing data using Unified APIs

remote_dataRecord<string, any>

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

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

urlsobject[]

The invoice URLs

typestring

Type of invoice URL

urlstring

The invoice URL

curl -X POST 'https://api.truto.one/unified/accounting/invoices/download?integrated_account_id=<integrated_account_id>' \
  -H 'Authorization: Bearer <your_api_token>' \
  -H 'Content-Type: application/json' \
  -d '{
  "remote_data": {}
}'
const integratedAccountId = '<integrated_account_id>';

const body = {
  "remote_data": {}
};

const response = await fetch(`https://api.truto.one/unified/accounting/invoices/download?integrated_account_id=${integratedAccountId}`, {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer <your_api_token>',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify(body),
});

const data = await response.json();
console.log(data);
import requests

url = "https://api.truto.one/unified/accounting/invoices/download"
headers = {
    "Authorization": "Bearer <your_api_token>",
    "Content-Type": "application/json",
}
params = {
    "integrated_account_id": "<integrated_account_id>"
}
payload = {
    "remote_data": {}
}

response = requests.post(url, headers=headers, params=params, json=payload)
print(response.json())
import Truto from '@truto/truto-ts-sdk';

const truto = new Truto({
  token: '<your_api_token>',
});

// Custom method: download
const result = await truto.unifiedApi.download(
  'accounting',
  'invoices',
  { integrated_account_id: '<integrated_account_id>' }
);

console.log(result);
import asyncio
from truto_python_sdk import TrutoApi

truto_api = TrutoApi(token="<your_api_token>")

async def main():
    # Custom method: download
    result = await truto_api.unified_api.download(
        "accounting",
        "invoices",
        {"integrated_account_id": "<integrated_account_id>"}
    )
    print(result)

asyncio.run(main())