Create Payments
/unified/accounting/payments
Query Parameters
Refer Specifying query parameters in Truto APIs
Whether this is a bill payment or an invoice payment.
billinvoice
1 supported1 required
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.debugreturns the final unified result alongside raw remote fetch information. The response is an envelope containingresult(identical to unified mode output) anddebug(withrequestUrl,requestOptions,data,responseHeaders, and for list operations:nextCursor,isLooping,isEmptyResult,resultCount).debugisnullfor static responses or whentruto_skip_api_call=true.
Defaults to unified.
unifiedunifiedrawnormalizedstreamdebug
Excludes the remote_data attribute from the response.
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.
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]=barRequest Body
Refer Writing data using Unified APIs
The unique identifier for payments
4 supported1 required
For bill payments, the bank or credit card the payment is made from. For invoice payments, the account the payment is deposited to.
3 supported
The ID of the company the payment belongs to
1 supported
The contact of the payment
4 supported1 required
The ID of the contact
The type of the contact. Can be customer or vendor.
customervendorcustomervendorcustomervendor
This represents the date when the payment was created
4 supported
The currency of the payment
3 supported1 required
The exchange rate of the payment
2 supported
The invoice associated with the payment
4 supported
The ID of the invoice
The type of the invoice
invoicebillinvoicebill
Bill payments only. The account the payment is made from must match — a bank account for Check, a credit card for CreditCard.
CheckCreditCard
1 supported
CheckCreditCardWhat entity was the payment for. Can be invoice or bill.
invoicebillinvoicebillinvoicebill
4 supported
invoicebillinvoicebillThe reference number for the payment. On bill payments this is the check number, on invoice payments it is the payment reference.
1 supported
The bills, invoices or credit memos this payment is applied to. Send multiple entries to split one payment across several.
1 supported1 required
The amount of the payment to apply to this bill or invoice.
The ID of the bill or invoice this portion of the payment is applied to.
Defaults to bill or invoice based on the payment_for query parameter. Use credit_memo to apply an existing credit on an invoice payment.
invoicebillcredit_memo
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.
The status of the payment.
2 supported
The total amount of the payment
4 supported2 required
The transaction date of the payment
4 supported1 required
This represents the date when the payment was updated
4 supported
Response Body
The unique identifier for payments
4 supported
The ID of the account for the payment
3 supported
The ID of the company the payment belongs to
1 supported
The contact of the payment
4 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
4 supported
The currency of the payment
3 supported
The exchange rate of the payment
2 supported
The invoice associated with the payment
4 supported
The ID of the invoice
The type of the invoice
invoicebill
What entity was the payment for. Can be invoice or bill.
invoicebill
4 supported
Raw data returned from the remote API call.
The status of the payment.
2 supported
The total amount of the payment
4 supported
The transaction date of the payment
4 supported
This represents the date when the payment was updated
4 supported
truto unified accounting payments \
-m create \
-a '<integrated_account_id>' \
-b '{
"payment_for": "invoice",
"transaction_date": "your_transaction_date",
"contact": {},
"account": "your_account",
"exchange_rate": 0,
"company": "your_company",
"total_amount": 0,
"id": "your_id",
"status": "your_status",
"invoice": {},
"currency": "your_currency",
"created_at": "your_created_at",
"updated_at": "your_updated_at",
"pay_type": "Check",
"references": [],
"reference_number": "your_reference_number",
"remote_data": {}
}' \
-o jsonimport Truto from '@truto/truto-ts-sdk';
const truto = new Truto({
token: '<your_api_token>',
});
const result = await truto.unifiedApi.create(
'accounting',
'payments',
{
"payment_for": "invoice",
"transaction_date": "your_transaction_date",
"contact": {},
"account": "your_account",
"exchange_rate": 0,
"company": "your_company",
"total_amount": 0,
"id": "your_id",
"status": "your_status",
"invoice": {},
"currency": "your_currency",
"created_at": "your_created_at",
"updated_at": "your_updated_at",
"pay_type": "Check",
"references": [],
"reference_number": "your_reference_number",
"remote_data": {}
},
{ 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():
result = await truto_api.unified_api.create(
"accounting",
"payments",
{
"payment_for": "invoice",
"transaction_date": "your_transaction_date",
"contact": {},
"account": "your_account",
"exchange_rate": 0,
"company": "your_company",
"total_amount": 0,
"id": "your_id",
"status": "your_status",
"invoice": {},
"currency": "your_currency",
"created_at": "your_created_at",
"updated_at": "your_updated_at",
"pay_type": "Check",
"references": [],
"reference_number": "your_reference_number",
"remote_data": {}
},
{"integrated_account_id": "<integrated_account_id>"}
)
print(result)
asyncio.run(main())curl -X POST 'https://api.truto.one/unified/accounting/payments?integrated_account_id=<integrated_account_id>' \
-H 'Authorization: Bearer <your_api_token>' \
-H 'Content-Type: application/json' \
-d '{
"payment_for": "invoice",
"transaction_date": "your_transaction_date",
"contact": {},
"account": "your_account",
"exchange_rate": 0,
"company": "your_company",
"total_amount": 0,
"id": "your_id",
"status": "your_status",
"invoice": {},
"currency": "your_currency",
"created_at": "your_created_at",
"updated_at": "your_updated_at",
"pay_type": "Check",
"references": [],
"reference_number": "your_reference_number",
"remote_data": {}
}'const integratedAccountId = '<integrated_account_id>';
const body = {
"payment_for": "invoice",
"transaction_date": "your_transaction_date",
"contact": {},
"account": "your_account",
"exchange_rate": 0,
"company": "your_company",
"total_amount": 0,
"id": "your_id",
"status": "your_status",
"invoice": {},
"currency": "your_currency",
"created_at": "your_created_at",
"updated_at": "your_updated_at",
"pay_type": "Check",
"references": [],
"reference_number": "your_reference_number",
"remote_data": {}
};
const response = await fetch(`https://api.truto.one/unified/accounting/payments?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"
headers = {
"Authorization": "Bearer <your_api_token>",
"Content-Type": "application/json",
}
params = {
"integrated_account_id": "<integrated_account_id>"
}
payload = {
"payment_for": "invoice",
"transaction_date": "your_transaction_date",
"contact": {},
"account": "your_account",
"exchange_rate": 0,
"company": "your_company",
"total_amount": 0,
"id": "your_id",
"status": "your_status",
"invoice": {},
"currency": "your_currency",
"created_at": "your_created_at",
"updated_at": "your_updated_at",
"pay_type": "Check",
"references": [],
"reference_number": "your_reference_number",
"remote_data": {}
}
response = requests.post(url, headers=headers, params=params, json=payload)
print(response.json())