Skip to main content
POST
/
v0
/
business
/
{business_id}
/
credit-memo
Create one or more Credit Memos (max 100)
curl --request POST \
  --url https://api.sandbox.getasset.com/v0/business/{business_id}/credit-memo \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
[
  {
    "customer_id": "<string>",
    "number": "<string>",
    "amount": 100,
    "memo": "<string>",
    "issued_at": "2026-01-15T00:00:00Z",
    "tags": {
      "Location": "NYC"
    }
  }
]
'
{
  "data": [
    {
      "business_id": "<string>",
      "customer_id": "<string>",
      "number": "<string>",
      "amount": 123,
      "issued_at": "2023-11-07T05:31:56Z",
      "journal_entry_id": "<string>",
      "id": "<string>",
      "voided": true,
      "memo": "<string>",
      "void_journal_entry_id": "je_R2fAXCjqJPdpYata112zyW",
      "voided_at": "2023-11-07T05:31:56Z",
      "created_by": "<string>",
      "tags": {
        "Job": [
          {
            "amount": "60.00",
            "value": "Maple Street Remodel"
          },
          {
            "amount": "40.00",
            "value": "Downtown Office Rewire"
          }
        ]
      }
    }
  ],
  "errors": [
    {
      "error": "<string>",
      "number": "<string>"
    }
  ]
}

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

x-user-id
string | null

Optional external entity identifier that performed the action

Path Parameters

business_id
string<biz_string>
required

Body

application/json
Maximum array length: 100
customer_id
string<cus_string>
required

The ID of the Customer to issue the credit to

Example:

"cus_ApaM9xeQtNyVk5qpaHJbNj"

number
string
required

The number of the credit memo. Must be unique per business.

Maximum string length: 255
Example:

"CM-001"

amount
required

The amount of the credit memo. Must be greater than zero.

Required range: x > 0
Example:

100

memo
string | null

Description of the credit memo

Maximum string length: 255
issued_at
string<date-time> | null

The date and time the credit memo was issued. Defaults to now.

Example:

"2026-01-15T00:00:00Z"

tags
Tags · object

Inline tag input. Each field maps to either a single value (string, e.g. 'NYC') or a list of {value, amount} objects to allocate the credit memo across multiple values. The tag field must already exist; values are created automatically if missing. Per-field sum of amounts must not exceed the credit memo amount.

Example:
{ "Location": "NYC" }

Response

Successful Response

data
CreditMemoPublic · object[]
required
errors
CreditMemoCreateError · object[]
required