List invoice credit memos

GET

https://integrators.prod.api.tabsplatform.com/v3/customers/:id/invoices/:invoiceId/credit-memos

GET

/v3/customers/:id/invoices/:invoiceId/credit-memos

$ curl https://integrators.prod.api.tabsplatform.com/v3/customers/id/invoices/invoiceId/credit-memos \
>      -H "Authorization: <apiKey>"

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

Authentication

Authorizationstring

API Key authentication via header

Path parameters

idstringRequiredformat: "uuid"

Customer ID

invoiceIdstringRequiredformat: "uuid"

Invoice ID

Response

Credit memos retrieved successfully

payloadlist of objects

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

Errors

404

Not Found Error

500

Internal Server Error