Download Payments

POST /unified/accounting/payments/download

QuickBooks

Query Parameters

Refer Specifying query parameters in Truto APIs

payment_forstring

Only invoice is supported — QuickBooks has no PDF for a bill payment.

References: Invoices → id

Possible values:

billinvoice

1 supported1 required

QuickBooks

required

invoice

idstring

The ID of the payment to download as a PDF.

1 supported1 required

QuickBooks

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). When the upstream body exceeds 1 MiB, data is replaced by { truto_truncated: true, truto_max_bytes, truto_excerpt }. 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_enforce_write_schemaboolean

Validates the request body against this method's request_body_schema before the request is sent to the underlying integration. When a field marked required is missing, Truto responds 400 with the missing field names under truto_error_insight.missing_required_body_fields instead of forwarding the call. Only the fields documented in request_body_schema are checked. A body carrying a non-empty remote_data object is forwarded unchecked, because remote_data is merged into the provider request and may already carry the required values. A field the mapping always supplies through its default body is treated as present, and a field that is only conditionally required is reported under truto_error_insight.conditionally_required_body_fields rather than rejected. Some integrations declare fields required on update that the provider only requires on create; check meta/{method} for the resource before enabling this on update calls. If you sent an Idempotency-Key and the request was rejected, use a fresh key when you retry with a corrected body: the idempotency cache is keyed on the integrated account, path and key only — it ignores the query string and the body — so reusing the key replays the rejection. Defaults to false, which forwards the request as-is.

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 payments

accountstring

The ID of the account for the payment

References: Accounts → id

companystring

The ID of the company the payment belongs to

References: CompanyInfo → id

contactobject

The contact of the payment

References: Contacts → id

idstring

The ID of the contact

typestring

The type of the contact. Can be customer or vendor.

Possible values:

customervendor

created_atstring · date-time

This represents the date when the payment was created

currencystring

The currency of the payment

exchange_ratenumber

The exchange rate of the payment

invoiceobject

The invoice associated with the payment

References: Invoices → id

idstring

The ID of the invoice

typestring

The type of the invoice

Possible values:

invoicebill

payment_forstring

What entity was the payment for. Can be invoice or bill.

References: Invoices → id

Possible values:

invoicebill

remote_dataRecord<string, any>

Raw data returned from the remote API call.

statusstring

The status of the payment.

total_amountnumber

The total amount of the payment

transaction_datestring · date-time

The transaction date of the payment

updated_atstring · date-time

This represents the date when the payment was updated

truto unified accounting payments \
  -m download \
  -a '<integrated_account_id>' \
  -o 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',
  'payments',
  { 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",
        "payments",
        {"integrated_account_id": "<integrated_account_id>"}
    )
    print(result)

asyncio.run(main())

curl -X POST 'https://api.truto.one/unified/accounting/payments/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/payments/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/payments/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())