Sign in
Invoice
Admin

Returns the JSON document bundle that drives the PDF/CSV renderers — line items, per-currency subtotals, fee account, issuer block, FX snapshots. Powers the Console preview.

Returns the JSON document bundle that drives the PDF/CSV renderers — line items, per-currency subtotals, fee account, issuer block, FX snapshots. Powers the Console preview.

get/api/v1/admin/invoices/{invoiceId}/document

Path parameters

invoiceIdstring uuid required

The invoiceId parameter

Response

Success

successboolean required

Indicates if the request was successful

Example response

{
  "success": true,
  "data": {
    "invoice": {
      "currency": "GBP",
      "total_amount": "1234.56",
      "amount_paid": "0.00",
      "outstanding_amount": "1234.56",
      "payments": [
        {
          "amount": "125.00",
          "currency": "GBP"
        }
      ],
      "fx_rates": [
        {
          "source_currency": "GBP",
          "rate": "0.85120000",
          "provider": "openexchangerates"
        }
      ]
    },
    "line_items": [
      {
        "deposit_currency": "GBP",
        "payout_currency": "GBP",
        "fee_currency": "GBP"
      }
    ],
    "currency_subtotals": [
      {
        "source_currency": "GBP"
      }
    ],
    "fee_account": {
      "currency": "GBP"
    },
    "fx_rates": [
      {
        "source_currency": "GBP",
        "rate": "0.85120000",
        "provider": "openexchangerates"
      }
    ]
  }
}

Changes

Changed in 2 of the 8 revisions of this API.11