Update Payments

PATCH /unified/accounting/payments/{id}

ERPNext

QuickBooks

Path Parameters

idstring

required·

The ID of the resource.

Example: 23423523

Query Parameters

Refer Specifying query parameters in Truto APIs

payment_forstring

Whether this is a bill payment or an invoice payment.

References: Invoices → id

Possible values:

billinvoice

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). 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

accountstring

For bill payments, the bank or credit card the payment was made from. For invoice payments, the account the payment is deposited to.

References: Accounts → id

2 supported

ERPNext

supported

QuickBooks

supported

companystring

The ID of the company the payment belongs to

References: CompanyInfo → id

1 supported

ERPNext

supported

contactobject

The contact of the payment

References: Contacts → id

2 supported

ERPNext

supported

QuickBooks

supported

idstring

The ID of the contact

typestring

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

Possible values:

customervendorcustomervendor

exchange_ratenumber

The exchange rate of the payment

1 supported

ERPNext

supported

payment_forstring

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

References: Invoices → id

Possible values:

invoicebillinvoicebill

2 supported

ERPNext

supported

invoicebill

QuickBooks

supported

reference_numberstring

On bill payments this is the check number, on invoice payments it is the payment reference.

1 supported

QuickBooks

supported

referencesobject[]

The bills, invoices or credit memos this payment is applied to. Replaces the entire allocation list.

1 supported

QuickBooks

supported

allocated_amountnumber

required·

How much of the payment to apply to this bill or invoice. Capped by QuickBooks at the document's open balance.

reference_idstring

required·

The ID of the bill or invoice this portion of the payment is applied to.

reference_typestring

Defaults to bill or invoice based on the payment_for query parameter. Use credit_memo to apply an existing credit on an invoice payment.

Possible values:

invoicebillcredit_memo

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.

statusstring

Update the status of the payment (e.g. to Submitted)

Possible values:

SubmittedCancelledDraft

1 supported

ERPNext

supported

SubmittedCancelledDraft

sync_tokenstring

QuickBooks version token used for optimistic locking on update. Read it from remote_data.SyncToken, or omit it and we fetch it.

1 supported

QuickBooks

supported

total_amountnumber

The value of the payment.

2 supported

ERPNext

supported

QuickBooks

supported

transaction_datestring · date-time

The transaction date of the payment

2 supported

ERPNext

supported

QuickBooks

supported

Response Body

idstring

required·

The unique identifier for payments

2 supported

ERPNext

supported

QuickBooks

supported

accountstring

The ID of the account for the payment

References: Accounts → id

2 supported

ERPNext

supported

QuickBooks

supported

companystring

The ID of the company the payment belongs to

References: CompanyInfo → id

1 supported

ERPNext

supported

contactobject

The contact of the payment

References: Contacts → id

2 supported

ERPNext

supported

QuickBooks

supported

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

2 supported

ERPNext

supported

QuickBooks

supported

currencystring

The currency of the payment

2 supported

ERPNext

supported

QuickBooks

supported

exchange_ratenumber

The exchange rate of the payment

1 supported

ERPNext

supported

invoiceobject

The invoice associated with the payment

References: Invoices → id

2 supported

ERPNext

supported

QuickBooks

supported

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

2 supported

ERPNext

supported

QuickBooks

supported

remote_dataRecord<string, any>

Raw data returned from the remote API call.

statusstring

The status of the payment.

1 supported

ERPNext

supported

total_amountnumber

The total amount of the payment

2 supported

ERPNext

supported

QuickBooks

supported

transaction_datestring · date-time

The transaction date of the payment

2 supported

ERPNext

supported

QuickBooks

supported

updated_atstring · date-time

This represents the date when the payment was updated

2 supported

ERPNext

supported

QuickBooks

supported

truto unified accounting payments '<resource_id>' \
  -m update \
  -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,
  "status": "Submitted",
  "references": [],
  "reference_number": "your_reference_number",
  "sync_token": "your_sync_token",
  "remote_data": {}
}' \
  -o json

import Truto from '@truto/truto-ts-sdk';

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

const result = await truto.unifiedApi.update(
  'accounting',
  'payments',
  '<resource_id>',
  {
  "payment_for": "invoice",
  "transaction_date": "your_transaction_date",
  "contact": {},
  "account": "your_account",
  "exchange_rate": 0,
  "company": "your_company",
  "total_amount": 0,
  "status": "Submitted",
  "references": [],
  "reference_number": "your_reference_number",
  "sync_token": "your_sync_token",
  "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.update(
        "accounting",
        "payments",
        "<resource_id>",
        {
        "payment_for": "invoice",
        "transaction_date": "your_transaction_date",
        "contact": {},
        "account": "your_account",
        "exchange_rate": 0,
        "company": "your_company",
        "total_amount": 0,
        "status": "Submitted",
        "references": [],
        "reference_number": "your_reference_number",
        "sync_token": "your_sync_token",
        "remote_data": {}
},
        {"integrated_account_id": "<integrated_account_id>"}
    )
    print(result)

asyncio.run(main())

curl -X PATCH 'https://api.truto.one/unified/accounting/payments/{id}?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,
  "status": "Submitted",
  "references": [],
  "reference_number": "your_reference_number",
  "sync_token": "your_sync_token",
  "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,
  "status": "Submitted",
  "references": [],
  "reference_number": "your_reference_number",
  "sync_token": "your_sync_token",
  "remote_data": {}
};

const response = await fetch(`https://api.truto.one/unified/accounting/payments/{id}?integrated_account_id=${integratedAccountId}`, {
  method: 'PATCH',
  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/{id}"
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,
    "status": "Submitted",
    "references": [],
    "reference_number": "your_reference_number",
    "sync_token": "your_sync_token",
    "remote_data": {}
}

response = requests.patch(url, headers=headers, params=params, json=payload)
print(response.json())