Credit Memos

Create a credit memo

Changed on

Create a new credit memo for a customer.

Use cases

  • Customer refunds
  • Service adjustments
  • Promotional credits
  • Manual corrections

Note

Credit memos from overpayments are created automatically when a payment exceeds invoice totals.

post/credit-memos

Request

  • Base URL: https://api.mvmnt.io/v1
  • URL: https://api.mvmnt.io/v1/credit-memos
  • Auth: HTTP bearer

Request body

customerIdstring uuid required

Customer to credit

amountnumber required

Credit amount

currencystring

Currency code (defaults to customer currency)

memoDatestring date required

Credit memo date

referencestring

Reference number

notesstring

Notes or description

Response

Credit memo created 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"
  }
}

Changes

  • 2cd6ecfbeb82Revision changes
    • breaking

      the response's body type changed from object to no type for status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • info

      added subschema #2 to the response body allOf list for the response status

    • info

      media type application/json was changed to a more specific media type application/problem+json for the response status

    • info

      media type application/json was changed to a more specific media type application/problem+json for the response status

    • info

      media type application/json was changed to a more specific media type application/problem+json for the response status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

  • ce0e9003047cRevision changes
    • warning

      added the new BLOCKED enum value to the / response property for the response status

    • warning

      added the new CLOSED enum value to the / response property for the response status

    • warning

      added the new CONTACTED enum value to the / response property for the response status

    • warning

      added the new NEW enum value to the / response property for the response status

    • warning

      added the new NURTURING enum value to the / response property for the response status

    • warning

      added the new PENDING enum value to the / response property for the response status

    • warning

      added the new QUALIFIED enum value to the / response property for the response status

    • warning

      added the new QUOTED enum value to the / response property for the response status

    • info

      removed the CHURNED enum value from the / response property for the response status

    • info

      removed the PROSPECT enum value from the / response property for the response status