List Payments
/unified/accounting/payments
Partial response — use the "get" endpoint for the full object.
Query Parameters
Refer Specifying query parameters in Truto APIs
What entity was the payment for. Can be invoice or bill.
billinvoice
6 supported3 required3 notes
What entity was the payment for.
The type of payment
What entity was the payment for.
The contact of the payment
6 supported
The ID of the contact
The type of the contact. Can be customer or vendor.
customervendor
This represents the date when the payment was created
5 supported
This represents the date when the payment was updated
6 supported
Set this value only when payment_for is bill. This should only accept items in ascending order.
total_amounttransaction_date
1 supported
Show Truto-specific parameters
The ID of the integrated account to use for the request.
62f44730-dd91-461e-bd6a-aedd9e0ad79dThe format of the response.
unifiedreturns the response with unified mappings applied.rawreturns the unprocessed, raw response from the remote API.normalizedapplies the unified mappings and returns the data in a normalized format.streamreturns 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.
Defaults to unified.
unifiedunifiedrawnormalizedstream
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.
idIgnores the limit query parameter.
Excludes the remote_data attribute from the response.
Array of fields to exclude from the response.
truto_exclude_fields[]=id&truto_exclude_fields[]=nameQuery parameters to pass to the underlying API without any transformations. Refer this guide to see how to structure the query parameters.
remote_query[foo]=barResponse Body
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.
List of Payments
The unique identifier for payments
7 supported
The ID of the account for the payment
5 supported
The ID of the company the payment belongs to
2 supported
The contact of the payment
6 supported
2 properties
The ID of the contact
The type of the contact. Can be customer or vendor.
customervendor
This represents the date when the payment was created
5 supported
The currency of the payment
5 supported
The exchange rate of the payment
3 supported
The invoice associated with the payment
4 supported
2 properties
The ID of the invoice
The type of the invoice
invoicebill
What entity was the payment for. Can be invoice or bill.
invoicebill
6 supported
Raw data returned from the remote API call.
The status of the payment.
3 supported
The total amount of the payment
6 supported
The transaction date of the payment
6 supported
This represents the date when the payment was updated
6 supported
curl -X GET 'https://api.truto.one/unified/accounting/payments?integrated_account_id=<integrated_account_id>' \
-H 'Authorization: Bearer <your_api_token>' \
-H 'Content-Type: application/json'const integratedAccountId = '<integrated_account_id>';
const response = await fetch(`https://api.truto.one/unified/accounting/payments?integrated_account_id=${integratedAccountId}`, {
method: 'GET',
headers: {
'Authorization': 'Bearer <your_api_token>',
'Content-Type': 'application/json',
},
});
const data = await response.json();
console.log(data);import requests
url = "https://api.truto.one/unified/accounting/payments"
headers = {
"Authorization": "Bearer <your_api_token>",
"Content-Type": "application/json",
}
params = {
"integrated_account_id": "<integrated_account_id>"
}
response = requests.get(url, headers=headers, params=params)
print(response.json())import Truto from '@truto/truto-ts-sdk';
const truto = new Truto({
token: '<your_api_token>',
});
const result = await truto.unifiedApi.list(
'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():
async for item in truto_api.unified_api.list(
"accounting",
"payments",
{"integrated_account_id": "<integrated_account_id>"}
):
print(item)
asyncio.run(main())