Sign in

v1

latestOpenAPI 3.1.02026-07-24111224223.3 KB
Credit Memos

Creates a credit memo

Opens a customer credit memo that reduces receivable exposure before you allocate it to specific invoices. Capture subsidiary, customer, line-level reasons, and tax treatment so finance can audit why the balance changed.

post/credit-memos

Request body

credit_memo_numberstring
customer_idstring uuid required
subsidiary_idstring uuid
credit_memo_datestring date required

Example request

{
  "items": [
    {
      "price": {
        "amount_per_unit": {
          "amount": "1.01",
          "currency": "USD"
        }
      },
      "revenue": {
        "account_code": "11112"
      },
      "tax_rate": {
        "tax_amount": {
          "amount": "1.01",
          "currency": "USD"
        },
        "country": "US"
      }
    }
  ],
  "external_references": [
    {
      "type": "xyzSystemId",
      "id": "234",
      "url": "https://xyzsystempage.com/ids/234"
    }
  ],
  "exchange_rate": {
    "base": "USD",
    "target": "USD"
  }
}

Response

OK

idstring uuid required
subsidiary_idstring uuid required
credit_memo_numberstring required
customer_idstring uuid required
credit_memo_datestring date required
status'UNAPPLIED' | 'PARTIALLY_APPLIED' | 'APPLIED' | 'REFUNDED' required
updated_atstring date-time required

ISO 8601 timestamp in UTC timezone (must end with 'Z')

Example response

{
  "credit_memo_number": "CM01",
  "items": [
    {
      "description": "Description",
      "revenue": {
        "account_code": "11112"
      },
      "total_amount": {
        "amount": "1.01",
        "currency": "USD"
      },
      "taxed_amount": {
        "amount": "1.01",
        "currency": "USD"
      },
      "net_amount": {
        "amount": "1.01",
        "currency": "USD"
      },
      "quantity": 1
    }
  ],
  "address": {
    "line1": "123 Main St",
    "line2": "Apt 4B",
    "city": "Nashville",
    "state": "TN",
    "zip_code": "37201",
    "country": "US"
  },
  "net_amount": {
    "amount": "1.01",
    "currency": "USD"
  },
  "total": {
    "amount": "1.01",
    "currency": "USD"
  },
  "applied_amount": {
    "amount": "1.01",
    "currency": "USD"
  },
  "remaining_amount": {
    "amount": "1.01",
    "currency": "USD"
  },
  "applications": [
    {
      "amount": {
        "amount": "1.01",
        "currency": "USD"
      }
    }
  ],
  "exchange_rate": {
    "base": "USD",
    "target": "USD"
  },
  "taxed_amount": {
    "amount": "1.01",
    "currency": "USD"
  },
  "external_references": [
    {
      "type": "xyzSystemId",
      "id": "234",
      "url": "https://xyzsystempage.com/ids/234"
    }
  ]
}