List credit memos

GET

https://integrators.prod.api.tabsplatform.com/v3/credit-memos

GET

/v3/credit-memos

curl -G https://integrators.prod.api.tabsplatform.com/v3/credit-memos \
     -H "Authorization: <apiKey>" \
     -d page=1 \
     -d limit=50

200Retrieved

{
  "payload": {
    "data": [
      {
        "creditMemoId": "123e4567-e89b-12d3-a456-426614174000",
        "creditMemoNumber": "CM-001",
        "creditMemoPrefix": "CM",
        "customerId": "123e4567-e89b-12d3-a456-426614174000",
        "manufacturerId": "123e4567-e89b-12d3-a456-426614174000",
        "issueDate": "2023-01-01T00:00:00.000Z",
        "total": 100,
        "memo": "Credit for defective product",
        "reason": "Product defect",
        "status": "OPEN",
        "creditAmountRemaining": 25,
        "customer": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "name": "Acme Corp",
          "nameWithPrefix": "CUST-001 Acme Corp"
        },
        "items": [
          {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "name": "Product A",
            "note": "Credit for defective product",
            "quantity": 1,
            "amount": 100,
            "salesTaxAmount": 8.25,
            "item": {
              "id": "123e4567-e89b-12d3-a456-426614174000",
              "name": "Product A",
              "externalId": "EXT-123"
            },
            "erpClass": {
              "id": "123e4567-e89b-12d3-a456-426614174000",
              "name": "Revenue"
            },
            "contraRevenueScheduleId": "123e4567-e89b-12d3-a456-426614174000"
          }
        ],
        "applications": [
          {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "creditMemoId": "123e4567-e89b-12d3-a456-426614174000",
            "invoiceId": "123e4567-e89b-12d3-a456-426614174000",
            "amountApplied": 100,
            "invoiceNumber": "INV-001",
            "invoicePrefix": "INV",
            "appliedAt": "2023-01-01T00:00:00.000Z"
          }
        ],
        "externalIds": [
          {
            "externalId": "EXT-123",
            "sourceType": "NETSUITE"
          }
        ],
        "createdAt": "2023-01-01T00:00:00.000Z",
        "lastUpdatedAt": "2023-01-01T00:00:00.000Z",
        "syncStatus": "NOT_SYNCED"
      }
    ],
    "limit": 1.1,
    "totalItems": 1.1,
    "currentPage": 1.1
  },
  "success": true,
  "message": "string",
  "error": {
    "code": 1.1,
    "message": "string",
    "details": {}
  }
}

Authentication

Authorizationstring

API Key authentication via header

Query parameters

pagedoubleRequiredDefaults to 1

Page Number

limitdoubleRequiredDefaults to 50

Number of items to return

filterstringOptional

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

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

payloadobject

Response payload, will be empty when success is false

successboolean

Boolean with true=success, false=failure

messagestring

Plain-text description of the result

errorobjectOptional

json element with any error messages or warnings