v1

latestOpenAPI 3.1.0Proprietary2026-08-06177398877.4 KB
Payment Terms

Filter payment terms

Filter payment terms using comprehensive query criteria with AND/OR logic and multiple operators. Supports complex filtering similar to GraphQL capabilities. Note: Soft-deleted payment terms are excluded by default (deletedAt defaults to { isNull: true }).

post/payment-terms/filter

Request body

pageSizeinteger

Number of results per page

cursorstring

Pagination cursor for next page

Example request

{
  "filter": {
    "and": [
      {
        "doNotUse": {
          "equalTo": false
        }
      },
      {
        "days": {
          "greaterThan": 0
        }
      }
    ]
  },
  "pageSize": 50
}

Response

Successful response

Example response

{
  "data": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "Net 30",
      "description": "Payment due 30 days from invoice date",
      "days": 30,
      "quickPayFee": 0.05,
      "key": "ERP-PAYTERM-NET30",
      "createdAt": "2025-01-15T10:00:00Z",
      "updatedAt": "2025-01-15T14:30:00Z"
    }
  ],
  "pagination": {
    "pageSize": 50,
    "hasNextPage": true,
    "endCursor": "eyJpZCI6IjU1MGU4NDAwLWUyOWItNDFkNC1hNzE2LTQ0NjY1NTQ0MDAwMCJ9"
  }
}