Sign in

v1

latestOpenAPI 3.1.02026-07-24111224223.3 KB
Charges

Retrieves a charge

Fetches a single charge with merchant metadata, amounts, and workflow state so reviewers can decide coding before reimbursement. Use this after list-all-charges surfaces an id that needs manual inspection or attachment to a bill.

get/charges/{charge_id}

Path parameters

charge_idstring required

UUID of the charge to be used in this operation.

Response

OK

vendor_idstring uuid required
charge_datestring date required
impact_datestring date
credit_card_account_codestring required

The account code found in the Chart of Accounts

subsidiary_idstring uuid
idstring uuid required
status'UNPAID' | 'PAID' | 'PARTIALLY_PAID' required
updated_atstring date-time required

Timestamp when the charge was last modified

Example response

{
  "items": [
    {
      "description": "API Charge",
      "account_code": "11112",
      "amount": {
        "amount": "1.01",
        "currency": "USD"
      },
      "tax_rate": {
        "tax_amount": {
          "amount": "1.01",
          "currency": "USD"
        },
        "country": "US"
      }
    }
  ],
  "credit_card_account_code": "11112",
  "external_references": [
    {
      "type": "xyzSystemId",
      "id": "234",
      "url": "https://xyzsystempage.com/ids/234"
    }
  ],
  "exchange_rate": {
    "base": "USD",
    "target": "USD"
  }
}