Invoices

Filter invoices

Changed on

Search for AR invoices using filter criteria.

Common Filters

  • By customer: { "filter": { "customerId": { "equalTo": "uuid" } } }
  • Unpaid: { "filter": { "status": { "in": ["AWAITING_PAYMENT", "PARTIALLY_PAID"] } } }
  • Overdue: { "filter": { "overdue": true } }
  • By shipment: { "filter": { "shipmentId": { "equalTo": "uuid" } } }
post/invoices/filter

Request

  • Base URL: https://api.mvmnt.io/v1
  • URL: https://api.mvmnt.io/v1/invoices/filter
  • Auth: HTTP bearer

Request body

pageSizeinteger
cursorstring

Response

Invoices matching filter criteria

Example response

{
  "data": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "friendlyId": "INV-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",
      "paymentTerm": {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "key": "ERP-PAYTERM-NET30",
        "name": "Net 30",
        "description": "Payment due 30 days from invoice date",
        "days": 30,
        "quickPayFee": 5,
        "createdAt": "2025-01-15T10:00:00Z",
        "updatedAt": "2025-01-15T14:30:00Z"
      }
    }
  ],
  "pagination": {
    "pageSize": 50,
    "hasNextPage": true,
    "endCursor": "eyJpZCI6IjU1MGU4NDAwLWUyOWItNDFkNC1hNzE2LTQ0NjY1NTQ0MDAwMCJ9"
  },
  "errors": [
    {
      "field": "/required",
      "message": "missing property 'status'"
    }
  ]
}

Changes

  • a67a66657930Revision changes
    • breaking

      added to the / request property allOf list

    • breaking

      the / request property type changed from object to no type

    • breaking

      the // response's property type changed from string to no type for status

    • warning

      removed the request property //

    • warning

      removed the request property //

    • warning

      removed the request property //

    • warning

      removed the request property //

    • info

      added to the // response property allOf list for the response status

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

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