Sign in

v1

latestOpenAPI 3.0.12026-07-144840447.2 KB
Hidden

Get customer invoices changes events

Returns the list of changes based on the provided start_date. If no start_date is provided it returns the oldest set of recorded changes. Changes for the last 4 weeks are retained. The items will be returned using processed_at in ASC order (oldest first).

ℹ️ This endpoint requires the following scope: customer_invoices:readonly

get/api/external/firm/v1/companies/{company_id}/changelogs/customer_invoices

Path parameters

company_idinteger required

Existing company identifier (id)

Query parameters

cursorstring
Example:MjAyNS0wMS0wOVQwODoyNDozOC44MTI0NTha

Cursor for pagination. Use this to fetch the next set of results. The cursor is an opaque string returned in the previous response's metadata. Leave empty for the first request.

limitinteger

Number of items to return per request. Defaults to 20 if not specified. Must be between 1 and 1000.

start_datestring date-time

Filter the changes based on the event date. The date should follow RFC3339 format. If no date is provided, the oldest changes will be returned. Changes for the last 4 weeks are retained, thus providing a start_date older than that will result in a 422 response. Providing both start_date and cursor parameters will result in a 400 response.

Response

A list of customer invoices changes

has_moreboolean required

Indicates whether additional results are available beyond this set. Use this flag to determine if another request is needed.

next_cursorstring nullable required

Cursor to retrieve the next set of results. Include this value in the cursor parameter of your next request to fetch subsequent items. A null next_cursor in the response indicates no further results.

Example response

{
  "has_more": true,
  "next_cursor": "SGVsbG8sIEJhc2U2NCBlbmNvZGluZyE="
}