---
title: "View payment terms group"
method: GET
path: "/api/v1/paymentTermsGroups/{id}"
tags: ["Payment Terms Group"]
---

# View payment terms group

`GET /api/v1/paymentTermsGroups/{id}`

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

## Path parameters

- `id` string, required — Resource identifier.

## 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.

## Other responses

- `401` — Unable to authenticate the client
- `403` — Unable to authorize the client
- `404` — Resource was not found or not enough access privileges
- `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)
