Skip to main content
POST
Apply a payment transaction to a confirmed bill

Authorizations

Authorization
string
header
required

API token issued from the Equated app under Settings → API Tokens.

Path Parameters

id
integer
required
Required range: x > 0

Body

application/json
transactionId
integer
required
Required range: x > 0
amount
string

Optional allocation in document currency. Omit to derive it from the whole payment/collection.

Pattern: ^\d+(\.\d+)?$
resolveWithAdjustment
boolean

Close a short payment through guarded realized FX or a credit/discount adjustment.

Response

200 - application/json

Action execution result

actionRequestId
string | null
required
status
string
required
changed
boolean
required

False when nothing was applied: the row was already in that state, or the preview was stale or expired.

result
object | null
required
error
string