Sign in

v1

latestOpenAPI 3.1.02026-07-24111224223.3 KB
Credit Memos

Updates credit memo taxes

Refreshes tax quotes on an existing credit memo using the same structured payload as invoice tax updates, stamped with taxesCalculatedAt for auditability. Use after line items change or when your tax engine recomputes jurisdiction-specific amounts before issuing the credit to the customer.

post/credit-memos/{credit_memo_id}/taxes

Path parameters

credit_memo_idstring required

UUID of the credit memo to be used in this operation.

Request body

taxes_calculated_atstring date-time required

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

Example request

{
  "items": [
    {
      "tax_rates": [
        {
          "tax_amount": {
            "amount": "1.01",
            "currency": "USD"
          },
          "country": "US"
        }
      ]
    }
  ]
}

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"
    }
  ]
}