latestOpenAPI 3.0.0Apache 2.02026-08-06199181.1 MB

e0d144609998

Invoices

Get invoice payment form data

Returns available asset and trust accounts for invoice payment.

get/invoices/payments/form-data

Query parameters

organization_idstring required
Example:0001

Organization ID

invoice_payment_idstring nullable

Invoice Payment ID (nullable)

client_idinteger
Example:2

Client ID

Response

Successful operation

messagestring

Example response

{
  "message": "success.",
  "invoice_payment_form_data": {
    "asset_accounts": [
      {
        "id": 454,
        "parent_id": 450,
        "name": "account 123456",
        "account_label": "account 123456 - USD (123129)",
        "currency": "USD",
        "currency_id": 234,
        "type_id": 1
      }
    ],
    "trust_accounts": [
      {
        "id": 20,
        "name": "Trust Asset Account",
        "account_label": "Trust Asset Account (USD)",
        "currency": "USD",
        "currency_id": 234,
        "balance": 10000000000
      }
    ]
  }
}