Filter payments

Changed on Oct 7, 2026

Search for AR payments using filter criteria.

Common Filters

By customer: { "filter": { "customerId": { "equalTo": "uuid" } } }
By invoice: { "filter": { "invoiceId": { "equalTo": "uuid" } } }
By date range: { "filter": { "paymentDate": { "greaterThanOrEqualTo": "2025-01-01T00:00:00Z" } } }
By method: { "filter": { "paymentMethodType": { "equalTo": "check" } } }

post/payments/filter

Request

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

Request body

pageSizeinteger

cursorstring

Response

Payments matching filter criteria

Example response

{
  "data": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "key": "PMT-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"
    }
  ],
  "pagination": {
    "pageSize": 50,
    "hasNextPage": true,
    "endCursor": "eyJpZCI6IjU1MGU4NDAwLWUyOWItNDFkNC1hNzE2LTQ0NjY1NTQ0MDAwMCJ9"
  },
  "errors": [
    {
      "field": "/required",
      "message": "missing property 'status'"
    }
  ]
}

Changes

Oct 7, 20262cd6ecfbeb82 Revision 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
Aug 15, 2026ce0e9003047c Revision 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

Operation history