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

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

creditMemoIdstring

Credit memo ID

creditMemoNumberstring

Credit memo number

creditMemoPrefixstring

Credit memo prefix

customerIdstring

Customer ID

manufacturerIdstring

Manufacturer ID

issueDatedatetime

Issue date

totaldouble

Total amount

statusstring

Status

customerobject

Customer information

itemslist of objects

Line items

applicationslist of objects

Applications

externalIdslist of objects

External IDs

createdAtdatetime

Created at

lastUpdatedAtdatetime

Last updated at

syncStatusstring

Sync status

memostringOptional

Memo

reasonstringOptional

Reason

Errors

400

Bad Request Error

500

Internal Server Error