Create credit memo

POST

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

POST

/v3/credit-memos

$ curl -X POST https://integrators.prod.api.tabsplatform.com/v3/credit-memos \
>      -H "Authorization: <apiKey>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "customerId": "123e4567-e89b-12d3-a456-426614174000",
>   "issueDate": "2023-01-10",
>   "reason": "Product defect",
>   "items": [
>     {
>       "quantity": 1,
>       "amount": 100
>     }
>   ]
> }'

1 {
2   "payload": {
3     "creditMemoId": "123e4567-e89b-12d3-a456-426614174000",
4     "creditMemoNumber": "CM-001",
5     "creditMemoPrefix": "CM",
6     "customerId": "123e4567-e89b-12d3-a456-426614174000",
7     "manufacturerId": "123e4567-e89b-12d3-a456-426614174000",
8     "issueDate": "2023-01-01T00:00:00.000Z",
9     "total": 100,
10     "status": "OPEN",
11     "creditAmountRemaining": 25,
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   "success": true,
61   "message": "string",
62   "error": {
63     "code": 1.1,
64     "message": "string",
65     "details": {}
66   }
67 }

Authentication

Authorizationstring

API Key authentication via header

Request

This endpoint expects an object.

customerIdstringRequired

Customer ID

issueDatestringRequired

Issue date

reasonstringRequired

Reason

itemslist of objectsRequired

Credit memo items

memostringOptional

Memo

applyOnCreateobjectOptional

Apply on create parameters. Do not include if you want to apply the credit memo to an invoice later.

Response

Credit memo created successfully

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

Errors

400

Bad Request Error

500

Internal Server Error