---
title: "Filter invoices"
method: POST
path: "/invoices/filter"
tags: ["Invoices"]
---

# Filter invoices

`POST /invoices/filter`

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" } } }`

## Request body

- InvoiceFilterRequest
  - `filter` InvoiceFilter
    - `id` UUIDFilter — Filter options for UUID fields (all operations)
      - `equalTo` string, uuid — Exact match
      - `notEqualTo` string, uuid — Not equal to
      - `in` string[] — Matches any UUID in the array
      - `notIn` string[] — Does not match any UUID in the array
      - `isNull` boolean — Field is null (true) or not null (false)
    - `orderId` UUIDFilter — Filter options for UUID fields (all operations)
      - `equalTo` string, uuid — Exact match
      - `notEqualTo` string, uuid — Not equal to
      - `in` string[] — Matches any UUID in the array
      - `notIn` string[] — Does not match any UUID in the array
      - `isNull` boolean — Field is null (true) or not null (false)
    - `shipmentId` UUIDFilter — Filter options for UUID fields (all operations)
      - `equalTo` string, uuid — Exact match
      - `notEqualTo` string, uuid — Not equal to
      - `in` string[] — Matches any UUID in the array
      - `notIn` string[] — Does not match any UUID in the array
      - `isNull` boolean — Field is null (true) or not null (false)
    - `customerId` UUIDFilter — Filter options for UUID fields (all operations)
      - `equalTo` string, uuid — Exact match
      - `notEqualTo` string, uuid — Not equal to
      - `in` string[] — Matches any UUID in the array
      - `notIn` string[] — Does not match any UUID in the array
      - `isNull` boolean — Field is null (true) or not null (false)
    - `status` InvoiceStatusFilter
      - `equalTo` 'DRAFT' | 'AWAITING_PAYMENT' | 'PARTIALLY_PAID' | 'PAID' | 'VOIDED' — Current status of the invoice. - `DRAFT`: Invoice record exists but not finalized - `AWAITING_PAYMENT`: Invoice finalized, awaiting payment - `PARTIALLY_PAID`: Some payments received, balance remains - `PAID`: Fully paid - `VOIDED`: Invoice cancelled/voided
      - `notEqualTo` 'DRAFT' | 'AWAITING_PAYMENT' | 'PARTIALLY_PAID' | 'PAID' | 'VOIDED' — Current status of the invoice. - `DRAFT`: Invoice record exists but not finalized - `AWAITING_PAYMENT`: Invoice finalized, awaiting payment - `PARTIALLY_PAID`: Some payments received, balance remains - `PAID`: Fully paid - `VOIDED`: Invoice cancelled/voided
      - `in` InvoiceStatus[]
      - `notIn` InvoiceStatus[]
    - `invoiceDate` DatetimeFilter — Filter options for datetime fields
      - `equalTo` string, date-time — Exact match
      - `notEqualTo` string, date-time — Not equal to
      - `lessThan` string, date-time — Before this datetime
      - `lessThanOrEqualTo` string, date-time — On or before this datetime
      - `greaterThan` string, date-time — After this datetime
      - `greaterThanOrEqualTo` string, date-time — On or after this datetime
      - `isNull` boolean — Field is null (true) or not null (false)
    - `dueDate` DatetimeFilter — Filter options for datetime fields
      - `equalTo` string, date-time — Exact match
      - `notEqualTo` string, date-time — Not equal to
      - `lessThan` string, date-time — Before this datetime
      - `lessThanOrEqualTo` string, date-time — On or before this datetime
      - `greaterThan` string, date-time — After this datetime
      - `greaterThanOrEqualTo` string, date-time — On or after this datetime
      - `isNull` boolean — Field is null (true) or not null (false)
    - `amount` FloatFilter — Filter options for float/number fields
      - `equalTo` number, float — Exact match
      - `notEqualTo` number, float — Not equal to
      - `lessThan` number, float — Less than
      - `lessThanOrEqualTo` number, float — Less than or equal to
      - `greaterThan` number, float — Greater than
      - `greaterThanOrEqualTo` number, float — Greater than or equal to
      - `isNull` boolean — Field is null (true) or not null (false)
    - `amountOwed` FloatFilter — Filter options for float/number fields
      - `equalTo` number, float — Exact match
      - `notEqualTo` number, float — Not equal to
      - `lessThan` number, float — Less than
      - `lessThanOrEqualTo` number, float — Less than or equal to
      - `greaterThan` number, float — Greater than
      - `greaterThanOrEqualTo` number, float — Greater than or equal to
      - `isNull` boolean — Field is null (true) or not null (false)
    - `overdue` boolean — Filter to overdue invoices only
    - `factored` boolean — Filter to factored invoices only
    - `createdAt` DatetimeFilter — Filter options for datetime fields
      - `equalTo` string, date-time — Exact match
      - `notEqualTo` string, date-time — Not equal to
      - `lessThan` string, date-time — Before this datetime
      - `lessThanOrEqualTo` string, date-time — On or before this datetime
      - `greaterThan` string, date-time — After this datetime
      - `greaterThanOrEqualTo` string, date-time — On or after this datetime
      - `isNull` boolean — Field is null (true) or not null (false)
    - `and` InvoiceFilter[]
    - `or` InvoiceFilter[]
    - `not` InvoiceFilter — recursive
  - `pageSize` integer
  - `cursor` string

## Response `200`

Invoices matching filter criteria

- object
  - `data` Invoice[], required
    - `id` string, uuid, required
    - `friendlyId` string, required — Human-readable invoice ID
    - `key` string, nullable — Client-defined key
    - `orderId` string, uuid — Associated order ID
    - `orderKey` string, nullable — Order friendly ID
    - `shipmentId` string, uuid — Associated shipment ID
    - `shipmentKey` string, nullable — Shipment friendly ID
    - `customer` CustomerReference — Enhanced reference to a customer resource (returned in responses). Includes full customer details in addition to id/key. Note: Does NOT include nested references (paymentTerm, contacts, etc.) to prevent recursion. Maximum nesting depth: 1 level.
      - `id` string, uuid, required — Customer UUID
      - `key` string, nullable — Client-defined reference ID if set
      - `name` string, required — Customer company name
      - `friendlyId` string, required — Human-readable customer identifier
      - `status` 'NEW' | 'CONTACTED' | 'QUALIFIED' | 'QUOTED' | 'NURTURING' | 'PENDING' | 'ACTIVE' | 'INACTIVE' | 'BLOCKED' | 'CLOSED', required — Customer status
      - `phoneNumber` string, nullable — Primary phone number
      - `website` string, nullable — Customer website URL
      - `createdAt` string, date-time, required — When the customer was created
      - `updatedAt` string, date-time, required — When the customer was last updated
      - `deletedAt` string, date-time, nullable — When the customer was soft deleted (null if active)
    - `status` 'DRAFT' | 'AWAITING_PAYMENT' | 'PARTIALLY_PAID' | 'PAID' | 'VOIDED', required — Current status of the invoice. - `DRAFT`: Invoice record exists but not finalized - `AWAITING_PAYMENT`: Invoice finalized, awaiting payment - `PARTIALLY_PAID`: Some payments received, balance remains - `PAID`: Fully paid - `VOIDED`: Invoice cancelled/voided
    - `invoiceDate` string, date, required — Date invoice was issued
    - `dueDate` string, date, nullable — Payment due date
    - `amount` number, required — Total invoice amount
    - `currency` string, nullable — Currency code (USD, CAD)
    - `reference` string, nullable — External reference number
    - `amountPaid` number — Total payments received
    - `amountOwed` number — Outstanding balance
    - `creditsApplied` number, nullable — Total credits applied
    - `paymentTerm` PaymentTermReference — Enhanced reference to a payment term resource (returned in responses). Includes full payment term details in addition to id/key.
      - `id` string, uuid, required — Payment term UUID
      - `key` string, nullable — Client-defined reference ID if set
      - `name` string, required — Payment term name
      - `description` string, nullable — Payment term description or notes
      - `days` integer, nullable — Number of days until payment is due
      - `quickPayFee` number, float, nullable — Quick pay fee percentage (e.g., 0.05 for 5%)
      - `apOnly` boolean, nullable — Whether this payment term is for accounts payable only
      - `doNotUse` boolean, nullable — Flag to prevent using this payment term for new transactions
      - `createdAt` string, date-time, required — When the payment term was created
      - `updatedAt` string, date-time, required — When the payment term was last updated
      - `deletedAt` string, date-time, nullable — When the payment term was soft deleted (null if active)
    - `payments` InvoicePayment[] — Payments applied to this invoice
      - `id` string, uuid
      - `paymentGroupId` string, uuid
      - `amount` number — Amount applied to this invoice
      - `paymentDate` string, date
      - `reference` string, nullable — Check number, transaction ID, etc.
      - `paymentMethodType` string, nullable — Payment method (check, ach_wire, etc.)
    - `credits` InvoiceCredit[] — Credits applied to this invoice
      - `id` string, uuid
      - `creditMemoId` string, uuid
      - `creditMemoReference` string, nullable
      - `amount` number — Credit amount applied
      - `appliedAt` string, date-time
    - `factorName` 'ARTISPAY' | 'DENIM' | 'HAUL_PAY' | 'TRIUMPH' — Factoring provider for invoice financing. - `DENIM`: Denim factoring - `HAULPAY`: HaulPay factoring
    - `factorJobId` string, nullable — External factoring job ID
    - `factorStatus` string, nullable — Current factoring status
    - `qboId` string, nullable — QuickBooks Online invoice ID
    - `documentId` string, uuid, nullable — Generated invoice PDF document ID
    - `documentUrl` string, nullable — Download URL for invoice PDF
    - `createdAt` string, date-time, required
    - `updatedAt` string, date-time, nullable
  - `pagination` PaginationInfo, required
    - `pageSize` integer, required — Number of items per page
    - `hasNextPage` boolean, required — Whether there are more pages
    - `hasPreviousPage` boolean — Whether there are previous pages
    - `endCursor` string, nullable — Cursor for the next page (null if no next page)

## Other responses

- `400` — Bad request - invalid input
- `401` — Unauthorized - invalid or missing access token
- `422` — Validation error - invalid field values

---

[API](https://skmtc.dev/mvmnt/apis/mvmnt-api.md) · [All operations](https://skmtc.dev/mvmnt/apis/mvmnt-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/mvmnt/mvmnt-api/revisions/7af4e91459ca/schema)