---
title: "Create payment terms group"
method: POST
path: "/api/v1/paymentTermsGroups"
tags: ["Payment Terms Group"]
---

# Create payment terms group

`POST /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>.

## Request body

- object
  - `key` string, required
  - `name` string, required
  - `comment` string, nullable
  - `isActive` boolean
  - `paymentTerms` object, nullable
    - `basicDiscount` number, nullable
    - `paymentTargetDays` integer, nullable — default: 14 days
    - `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.

## Response `201`

Resource successfully created response

## Other responses

- `400` — IETF RFC 9457 Problem API compliant response
- `403` — Unable to authorize the client
- `415` — Resource representation send in the request is not supported.
- `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)