Credit Memos

Apply credit to invoice

Changed on

Not available as a standalone operation; returns 501.

A credit memo is applied as part of a payment, the same way the TMS applies it: send it in creditApplications on POST /payments, together with the invoices in applications. The credit is spread over those invoices in order, each absorbing up to its own applied amount. The total credit cannot exceed the total applied to invoices.

post/credit-memos/{id}/apply

Request

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

Path parameters

idstring required

Resource ID (UUID) or client key

Query parameters

by'id' | 'key'

Specify lookup type for faster retrieval. If omitted, defaults to looking up by ID first, then falls back to client key if not found. Use by=key when you know you're providing a client key for best performance.

Request body

invoiceIdstring uuid required

Invoice to apply credit to

amountnumber required

Amount to apply

Response

Credit applied successfully

Example response

{
  "creditMemo": {
    "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

    • 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

    • 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

      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 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

    • 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

    • 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