v1

latestOpenAPI 3.0.02026-07-24161215397.4 KB

Charges

Retrieve all charges

Retrieve all charges for a specific invoice.

Required scopes: flex.billing.charges.read

get/api/v2/organizations/{orgSlug}/charges

Path parameters

orgSlugstring required

organization slug

Query parameters

_idstring

Filter by the _id of the charge. Supports both single id values (e.g., _id=603dfbc260f4054084125d33) and array operations (e.g., _id[$in]=603dfbc260f4054084125d33,603dfbc260f4054084125d34). Note: Multiple values in simple string format (e.g., _id=603dfbc260f4054084125d33,603dfbc260f4054084125d34) are not allowed - use _id[$in] format instead.

statusstring

Filter by status of the invoice, credit note, or overpayment. Supports both single status values (e.g., status=success) and array operations (e.g., status[$in]=success,pending). Note: Multiple values in simple string format (e.g., status=success,pending) are not allowed - use status[$in]=success,pending format instead.

paymentstring

Example:6080186f490fcf6e0547ec50

Filter by reference to the invoice, to which the charge belongs to.

sourcestring

Example:Quickbooks

Filter by the source of the charge. The source will be an accounting integration if the charge is synced from an integration.

datestring

Example:date[$gte]=YYYY-MM-DDTHH:mm:ssZ

Filter by the date of the charge. Supports date comparison filters: $gt, $gte, $lt, $lte

modifiedAtstring

Example:modifiedAt[$gte]=YYYY-MM-DDTHH:mm:ssZ

Filter by the modified date. Supports date comparison filters: $gt, $gte, $lt, $lte

createdAtstring

Example:createdAt[$gte]=YYYY-MM-DDTHH:mm:ssZ

Support date comparison filters: $gt, $gte, $lt, $lte

$selectstring

Example:recipient,sender

Select fields to return

$cursorNextstring

$cursorPrevstring

$limitnumber

$sortstring

Example:propertyName:asc

Sort expression in the format <field>:<order>, where order is asc or desc

Response

rangeStartnumber

rangeEndnumber

cursorNextstring

cursorPrevstring

Example response

{
  "results": [
    {
      "_id": "6080186f490fcf6e0547ec50",
      "amount": 15,
      "currency": "USD",
      "account": "Cash",
      "reference": "Charge Reference 1",
      "date": "2025-01-01T00:00:00.000Z",
      "accounting": {
        "provider": "xero",
        "providerId": "123456789",
        "externalOrgId": "987654321",
        "deepLink": "https://quickbooks.com/123456789",
        "lastSync": "2025-01-01T00:00:00.000Z",
        "error": "An error occurred while syncing with Xero"
      },
      "source": "API",
      "payment": "6080186f490fcf6e0547ec50",
      "providerChargeReference": "ch_3ABC123DEF456",
      "createdAt": "2025-01-01T00:00:00.000Z",
      "createdBy": "6080186f490fcf6e0547ec50",
      "modifiedAt": "2025-01-01T00:00:00.000Z",
      "modifiedBy": "6080186f490fcf6e0547ec50"
    }
  ]
}