v1

latestOpenAPI 3.1.0Proprietary2026-08-06177398877.4 KB

Credit Memos

Unapply credit from invoice

Remove a credit application from an invoice.

What happens

Application record is deleted
Credit memo remaining balance increases
Invoice open balance increases
Order status may revert if invoice becomes unpaid

delete/credit-memos/{creditMemoId}/applications/{applicationId}

Path parameters

creditMemoIdstring required

Credit memo ID

applicationIdstring uuid required

Application ID

Response

Credit unapplied successfully

idstring uuid required

keystring nullable

Client-defined key

referencestring nullable

Reference number

amountnumber required

Original credit amount

appliedAmountnumber

Total amount applied to invoices

remainingBalancenumber required

Available balance

currencystring nullable

Currency code

status'OPEN' | 'PARTIALLY_APPLIED' | 'APPLIED' | 'VOIDED' required

Current status of the credit memo (derived from remaining balance).

OPEN: No applications, full balance available
PARTIALLY_APPLIED: Some amount applied, balance remains
APPLIED: Fully applied to invoices
VOIDED: Credit memo cancelled

memoDatestring date required

Credit memo date

notesstring nullable

Notes or description

sourcePaymentGroupIdstring uuid nullable

Payment that created this credit (if from overpayment)

sourcePaymentKeystring nullable

qboIdstring nullable

QuickBooks Online credit memo ID

createdAtstring date-time required

updatedAtstring date-time nullable

voidedAtstring date-time nullable

voidReasonstring nullable

Example response

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "reference": "CM-00001",
  "customer": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "key": "ERP-CUSTOMER-ACME",
    "name": "Acme Manufacturing Corp",
    "friendlyId": "A123456",
    "status": "ACTIVE",
    "phoneNumber": "+1-555-123-4567",
    "website": "https://acme-manufacturing.com",
    "createdAt": "2025-01-15T10:00:00Z",
    "updatedAt": "2025-01-15T14:30:00Z"
  },
  "currency": "USD",
  "createdBy": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "key": "ERP-USER-12345",
    "email": "john.doe@example.com",
    "name": "John Doe",
    "phone": "+1-555-123-4567",
    "phoneExt": "123",
    "status": "ACTIVE",
    "avatarId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
    "createdAt": "2025-01-15T10:00:00Z",
    "updatedAt": "2025-01-15T14:30:00Z"
  }
}