creditMemos

List credit memos

get/v3/credit-memos

Request

  • Base URL: https://integrators.prod.api.tabsplatform.com
  • URL: https://integrators.prod.api.tabsplatform.com/v3/credit-memos
  • Auth: API key in header Authorization

Query parameters

pagenumber double required

Page Number

limitnumber double required

Number of items to return

filterstring

Format: field:rule:value — comma-separated for multiple filters.

Fields: creditMemoNumber (string): eq customerId (uuid): eq issueDateFrom (datetime): gte issueDateTo (datetime): lte status (string): eq, in (one of: OPEN, PARTIALLY_APPLIED, APPLIED, VOID) syncStatus (string): eq, in (one of: NOT_SYNCED, SYNCING, SYNCED, SYNC_FAILED) lastUpdatedAt (datetime): eq, gt, gte, lt, lte

Date-only values (YYYY-MM-DD) match the full UTC day.

Example: filter=creditMemoNumber:eq:value

Response

Get all Credit Memos by filter

payloadV3CreditMemosGetResponsesContentApplicationJsonSchemaPayload required

Response payload, will be empty when success is false

successboolean required

Boolean with true=success, false=failure

messagestring required

Plain-text description of the result

Changes

No recorded changes to this operation across all 1 revision of this API.