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

1 {
2   "payload": {
3     "data": [
4       {
5         "creditMemoId": "123e4567-e89b-12d3-a456-426614174000",
6         "creditMemoNumber": "CM-001",
7         "creditMemoPrefix": "CM",
8         "customerId": "123e4567-e89b-12d3-a456-426614174000",
9         "manufacturerId": "123e4567-e89b-12d3-a456-426614174000",
10         "issueDate": "2023-01-01T00:00:00.000Z",
11         "total": 100,
12         "memo": "Credit for defective product",
13         "reason": "Product defect",
14         "status": "OPEN",
15         "customer": {
16           "id": "123e4567-e89b-12d3-a456-426614174000",
17           "name": "Acme Corp",
18           "nameWithPrefix": "CUST-001 Acme Corp"
19         },
20         "items": [
21           {
22             "id": "123e4567-e89b-12d3-a456-426614174000",
23             "name": "Product A",
24             "note": "Credit for defective product",
25             "quantity": 1,
26             "amount": 100,
27             "salesTaxAmount": 8.25,
28             "item": {
29               "id": "123e4567-e89b-12d3-a456-426614174000",
30               "name": "Product A",
31               "externalId": "EXT-123"
32             },
33             "erpClass": {
34               "id": "123e4567-e89b-12d3-a456-426614174000",
35               "name": "Revenue"
36             },
37             "contraRevenueScheduleId": "123e4567-e89b-12d3-a456-426614174000"
38           }
39         ],
40         "applications": [
41           {
42             "id": "123e4567-e89b-12d3-a456-426614174000",
43             "creditMemoId": "123e4567-e89b-12d3-a456-426614174000",
44             "invoiceId": "123e4567-e89b-12d3-a456-426614174000",
45             "amountApplied": 100,
46             "invoiceNumber": "INV-001",
47             "invoicePrefix": "INV",
48             "appliedAt": "2023-01-01T00:00:00.000Z"
49           }
50         ],
51         "externalIds": [
52           {
53             "externalId": "EXT-123",
54             "sourceType": "NETSUITE"
55           }
56         ],
57         "createdAt": "2023-01-01T00:00:00.000Z",
58         "lastUpdatedAt": "2023-01-01T00:00:00.000Z",
59         "syncStatus": "NOT_SYNCED"
60       }
61     ],
62     "limit": 1.1,
63     "totalItems": 1.1,
64     "currentPage": 1.1
65   },
66   "success": true,
67   "message": "string",
68   "error": {
69     "code": 1.1,
70     "message": "string",
71     "details": {}
72   }
73 }

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, neq, like, nlike, in, nin, isnull, isnotnull customerId (uuid): eq, neq, in, nin, isnull, isnotnull issueDateFrom (datetime): eq, neq, gt, gte, lt, lte issueDateTo (datetime): eq, neq, gt, gte, lt, lte status (string): eq, neq, like, nlike, in, nin, isnull, isnotnull lastUpdatedAt (datetime): eq, neq, 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, neq, like, nlike, in, nin, isnull, isnotnull customerId (uuid): eq, neq, in, nin, isnull, isnotnull issueDateFrom (datetime): eq, neq, gt, gte, lt, lte issueDateTo (datetime): eq, neq, gt, gte, lt, lte status (string): eq, neq, like, nlike, in, nin, isnull, isnotnull lastUpdatedAt (datetime): eq, neq, 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

errorobject

json element with any error messages or warnings