Appearance

Update Payments ​

Endpoint ​

http
PATCH /unified/accounting/payments/{id}
Integrations supported
  • ERPNext

Path parameters ​

id
string
REQUIRED · 

The ID of the resource.

Example: 23423523

Query parameters ​

Refer Specifying query parameters in Truto APIs

integrated_account_id
string · uuid
REQUIRED · 

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

Example: 62f44730-dd91-461e-bd6a-aedd9e0ad79d
truto_response_format
string

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.

Defaults to unified.

All possible enum values:
  • unified
  • raw
  • normalized
  • stream
Example: unified
truto_ignore_remote_data
boolean

Excludes the remote_data attribute from the response.

truto_exclude_fields
array

Array of fields to exclude from the response.

Example: truto_exclude_fields[]=id&truto_exclude_fields[]=name
remote_query
object

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

payment_for
string

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

References: Invoices → id
All possible enum values:
  • invoice
  • bill
Enum support by integration
  • ERPNext
    • invoice
    • bill
Supported in
  • ERPNext
transaction_date
string · date-time

The transaction date of the payment

Supported in
  • ERPNext
contact
object

The contact of the payment

References: Contacts → id
Supported in
  • ERPNext
id
string

The ID of the contact

type
string

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

All possible enum values:
  • customer
  • vendor
account
string

The ID of the account for the payment

References: Accounts → id
Supported in
  • ERPNext
exchange_rate
number

The exchange rate of the payment

Supported in
  • ERPNext
company
string

The ID of the company the payment belongs to

References: CompanyInfo → id
Supported in
  • ERPNext
total_amount
number

The total amount of the payment

Supported in
  • ERPNext
status
string

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

All possible enum values:
  • Submitted
  • Cancelled
  • Draft
Enum support by integration
  • ERPNext
    • Submitted
    • Cancelled
    • Draft
Supported in
  • ERPNext
remote_data
object

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 ​

id
string
REQUIRED · 

The unique identifier for payments

Supported in
  • ERPNext
payment_for
string

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

References: Invoices → id
All possible enum values:
  • invoice
  • bill
Supported in
  • ERPNext
status
string

The status of the payment.

Supported in
  • ERPNext
transaction_date
string · date-time

The transaction date of the payment

Supported in
  • ERPNext
contact
object

The contact of the payment

References: Contacts → id
Supported in
  • ERPNext
id
string

The ID of the contact

type
string

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

All possible enum values:
  • customer
  • vendor
account
string

The ID of the account for the payment

References: Accounts → id
Supported in
  • ERPNext
invoice
object

The invoice associated with the payment

References: Invoices → id
Supported in
  • ERPNext
id
string

The ID of the invoice

type
string

The type of the invoice

All possible enum values:
  • invoice
  • bill
currency
string

The currency of the payment

Supported in
  • ERPNext
exchange_rate
number

The exchange rate of the payment

Supported in
  • ERPNext
company
string

The ID of the company the payment belongs to

References: CompanyInfo → id
Supported in
  • ERPNext
total_amount
number

The total amount of the payment

Supported in
  • ERPNext
created_at
string · date-time

This represents the date when the payment was created

Supported in
  • ERPNext
updated_at
string · date-time

This represents the date when the payment was updated

Supported in
  • ERPNext
remote_data
object

Raw data returned from the remote API call.