POST /invoices/{id}/transaction

Applies a transaction to an invoice. The invoice status must be unpaid, and the transaction must have a non-zero unused amount.

Servers

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
amount Number No

Amount to be applied to the invoice. This value must not exceed the transaction amount. If omitted, the lesser of the unused transaction amount or the invoice due amount is used.

transactionId String Yes

ID of the parent transaction.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.