Sign in

v1

latestOpenAPI 3.0.02026-07-2455104.8 MB
Payment Terms Group

Create payment terms group

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

post/api/v1/paymentTermsGroups

Request body

keystring required
namestring required
commentstring nullable
isActiveboolean

Example request

{
  "key": "DISCOUNT_10-5",
  "name": "Customer Discount 10.5%",
  "comment": "Customers in this group get 10.5% discount on all orders. And free shipping if the order value is at least 99.99 EUR.",
  "paymentTerms": {
    "basicDiscount": 5.5,
    "paymentTargetDays": 30,
    "earlyPaymentDiscount": {
      "value": 2.1,
      "paymentTargetDays": 7
    },
    "postageFreeFrom": 99.99
  },
  "project": {
    "id": "1"
  },
  "category": {
    "id": "789"
  }
}

Response

Resource successfully created response