---
title: "List payment terms groups"
method: GET
path: "/api/v1/paymentTermsGroups"
tags: ["Payment Terms Group"]
---

# List payment terms groups

`GET /api/v1/paymentTermsGroups`

This endpoint is only available as early access version and will introduce breaking changes without further notice or versioning.

PaymentTermsGroups can be used to group customers with identical payment terms such as different discounts, payment targets, and free postage options. For more details about the group feature have a look at our <a href="https://help.xentral.com/hc/en-us/articles/360016722000-Groups">handbook article</a>.

## Query parameters

- `filter` object[]
  - `key` 'id' | 'name' | 'key' | 'isActive' | 'projectId' | 'categoryId' — Pass the array as filter[0][key], filter[0][op], filter[0][value]
  - `op` 'equals' | 'notEquals' | 'in' | 'notIn' | 'exactlyIn' | 'allIn' | 'allNotIn' | 'contains' | 'notContains' | 'startsWith' | 'endsWith' | 'greaterThan' | 'lessThan' | 'is'
  - `value` union
    - string — Used for the operations 'equals', 'notEquals', 'contains', 'notContains', 'startsWith', 'endsWith' and 'is'.
    - string[]
- `order` object[]
  - `field` 'id' | 'name' | 'key'
  - `dir` 'asc' | 'desc'
- `page` object
  - `number` string, required — Page number should be an integer greater than or equal to 1
  - `size` string, required — Page size should usually be an integer between 10 and 50.

## Response `200`

Operation completed successfully.

- object
  - `data` object[]
    - `id` string — Resource identifier.
    - `key` string
    - `name` string
    - `isActive` boolean
    - `comment` string, nullable
    - `paymentTerms` object, nullable
      - `basicDiscount` number, nullable
      - `paymentTargetDays` integer, nullable
      - `earlyPaymentDiscount` object, nullable
        - `value` number
        - `paymentTargetDays` integer
      - `postageFreeFrom` number, nullable — null = no free shipping; 0 = free shipping for all orders; > 0 = free shipping for orders with a value of at least this value
    - `project` object, nullable
      - `id` string — Resource identifier.
    - `category` object, nullable
      - `id` string — Resource identifier.
  - `extra` object
    - `totalCount` integer, required — the total count of all items
    - `page` object, required — The pagination object containing the current page number and size
      - `number` integer, required — The current page number
      - `size` integer, required — The size of the pages

## Other responses

- `401` — Unable to authenticate the client
- `403` — Unable to authorize the client
- `406` — Requested resource representation does not exist.
- `429` — Too many API calls made.

---

[API](https://skmtc.net/xentral/apis/xentral-api.md) · [All operations](https://skmtc.net/xentral/apis/xentral-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/xentral/xentral-api/revisions/8a27ba392442/schema)