Skip to main content
​
business_id
string<biz_string>
required

The ID of the Business that the credit memo is associated with

Example:

"biz_Pk2fNFDd8wj7EFeLWJywc7"

​
customer_id
string<cus_string>
required

The ID of the Customer that the credit memo is issued to

Example:

"cus_ApaM9xeQtNyVk5qpaHJbNj"

​
number
string
required

The number of the credit memo

Maximum string length: 255
Example:

"CM-001"

​
amount
number
required

The amount of the credit memo

Example:

100

​
issued_at
string<date-time>
required

The date and time the credit memo was issued

​
journal_entry_id
string<je_string>
required

The journal entry that issued the credit

Example:

"je_R2fAXCjqJPdpYata112zyW"

​
id
string<cm_string>
required

The ID of the credit memo

Example:

"cm_WQMDNUHpBThYSNh4AprDBo"

​
voided
boolean
required
read-only

Whether the credit memo has been voided

​
memo
string | null

Description of the credit memo

Maximum string length: 255
​
void_journal_entry_id
string<je_string> | null

The reversing journal entry created when the credit memo was voided

Example:

"je_R2fAXCjqJPdpYata112zyW"

​
voided_at
string<date-time> | null

The date and time the credit memo was voided

​
created_by
string | null

The entity that created the credit memo

Maximum string length: 255
​
tags
Tags · object

Tag field name to the list of values attached to the credit memo. Each value carries its allocated amount; a single-value field is still returned as a one-element list.

Example:
{
  "Job": [
    {
      "amount": "60.00",
      "value": "Maple Street Remodel"
    },
    {
      "amount": "40.00",
      "value": "Downtown Office Rewire"
    }
  ]
}