Skip to main content
POST
Add payment to a sale

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

X-Tenant
number
required

Tenant identifier. Send the Tenant ID in the X-Tenant header to scope API requests to a specific tenant.

Path Parameters

id
integer
required

The sale identifier

Body

application/json
amount
number
required

Monetary amount.

Required range: x >= 0.01
currency_id
integer | null

Filter by currency ID.

exchange_rate
number | null

Currency exchange rate.

Required range: x >= 0
transaction_date
string<date-time> | null

Transaction date (YYYY-MM-DD).

type
enum<string> | null

Filter by type.

Available options:
collection,
payment
description
string | null

The description.

Maximum string length: 65535
account_id
integer | null

Account ID.

Response

success
string
required
data
object
required