v1

latestOpenAPI 3.1.02026-08-04103211436.0 KB
ReconcilingItems

List reconciling items

Returns the reconciling items of a company, ordered by date (most recent first). Results are paginated: use limit to control page size and pass the returned nextPageToken to fetch the next page.

get/reconcilingitems/{companyId}

Path parameters

companyIdstring required

Query parameters

reconcilingSourceCustomIdstring

Filter items belonging to a given reconciling source (reconcilingSourceCustomId).

Filter items belonging to a given reconciling source (reconcilingSourceCustomId).

reconciledboolean

Filter by reconciliation status. false also matches items where the value is not set.

Filter by reconciliation status. false also matches items where the value is not set.

startDatestring date

Only return items dated on or after this date (inclusive).

Only return items dated on or after this date (inclusive).

endDatestring date

Only return items dated before this date (exclusive).

Only return items dated before this date (exclusive).

limitinteger

Maximum number of objects to return in the response. Default 500, maximum 2000.

Maximum number of objects to return in the response. Default 500, maximum 2000.

nextPageTokenstring

Token to fetch the next page of results, taken from the nextPageToken returned by the previous request with the same filters. Omit it to fetch the first page. An invalid or malformed token is rejected with 404.

Token to fetch the next page of results, taken from the nextPageToken returned by the previous request with the same filters. Omit it to fetch the first page. An invalid or malformed token is rejected with 404.

Response

Successful Response

nextPageTokenstring nullable

Token to fetch the next page of results. null when there are no more pages.

Example response

{
  "data": [
    {
      "amount": 199.9,
      "date": "2024-01-15T00:00:00Z",
      "description": "Stripe order #4821",
      "metadata": {
        "orderId": "ORD-48213"
      },
      "customId": "stripe-order-4821",
      "reconcilingSourceCustomId": "stripe-orders"
    }
  ]
}