v1

latestOpenAPI 3.0.02026-07-2455104.8 MB

Payment Terms Group

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

get/api/v1/paymentTermsGroups/{id}

Path parameters

idstring required

Resource identifier.

Example:17

The resource's identifier.

Response

Operation completed successfully.

Example response

{
  "data": {
    "id": "123",
    "key": "DISCOUNT-10",
    "name": "Customer Discount 10%",
    "isActive": true,
    "comment": "Customers in this group get 10% discount on all orders. And free shipping if the order value is at least 100.00 EUR.",
    "paymentTerms": {
      "basicDiscount": 10,
      "paymentTargetDays": 30,
      "earlyPaymentDiscount": {
        "value": 2,
        "paymentTargetDays": 15
      },
      "postageFreeFrom": 100
    },
    "project": {
      "id": "1"
    },
    "category": {
      "id": "789"
    }
  }
}