API Reference
  1. Invoices

Void an invoice

post
https://api-dev.gettrx.com/onboard/v1/invoices//void

Voids an invoice by ID only when its status is open. Invoices in any other status (draft, paid, voided, uncollectible, etc.) cannot be voided.

Path Params
string
required
length between 10 and 128

Invoice ID (e.g. inv_a11YYufWQzNY63zpQ6QSNRQhkUpVph4WRmzW0zWJO2znZKdVujZ0N0S22u). Must be valid, not soft deleted, and belong to the merchant account.

Headers
string
required

Secret key associated to the partner's account

string

(Optional) AccountId of the merchant. Only required when secretKey belongs to an "entity" account.

string

Unique Key String refNumber

Responses

Updated about 1 hour ago

Did this page help you?
Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 hour ago

Did this page help you?