v1

latestOpenAPI 3.0.02026-07-24102143224.1 KB

Credit Memos

Create credit memo

post/v3/credit-memos

Request body

customerIdstring required

Customer ID

issueDatestring required

Issue date

memostring

Memo

reasonstring required

Reason

Example request

{
  "customerId": "123e4567-e89b-12d3-a456-426614174000",
  "issueDate": "2023-01-10",
  "memo": "Credit for defective product",
  "reason": "Product defect",
  "items": [
    {
      "invoiceLineItemId": "123e4567-e89b-12d3-a456-426614174000",
      "quantity": 1,
      "amount": 100,
      "itemId": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "applyOnCreate": {
    "invoiceId": "123e4567-e89b-12d3-a456-426614174000"
  }
}

Response

Credit memo created successfully

creditMemoIdstring required

Credit memo ID

creditMemoNumberstring required

Credit memo number

creditMemoPrefixstring required

Credit memo prefix

customerIdstring required

Customer ID

manufacturerIdstring required

Manufacturer ID

issueDatestring date-time required

Issue date

totalnumber required

Total amount

memostring

Memo

reasonstring

Reason

statusstring required

Status

createdAtstring date-time required

Created at

lastUpdatedAtstring date-time required

Last updated at

syncStatusstring required

Sync status

Example response

{
  "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",
  "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"
}