ComponentProductDto

amountnumberrequired

Quantity/amount of the product

Example: 1

unit object

Unit configuration for this product

idnumberrequired

Unique identifier for the unit

Example: 1

unitLanguages object[]required

Translations of the unit in different languages

Array [

languagestringrequired

Language code

Possible values: [nl, en, de]

singularstringrequired

Singular form of the unit in this language

Example: hour

pluralstringrequired

Plural form of the unit in this language

Example: hours

]

globalbooleanrequired

Whether the unit is global

flexibilitystringrequired

Flexibility setting for the product

Possible values: [fixed, provisional, estimate]

recurringstringrequired

Recurring billing frequency

Possible values: [once, daily, weekly, monthly, yearly]

optionalbooleanrequired

Whether the product is optional

amountAdjustablebooleanrequired

Whether the amount is adjustable by the client

minimumAmountnumber

Minimum allowed amount for the client to set

Example: 0

maximumAmountnumber

Maximum allowed amount for the client to set

Example: 1000

wholeNumbersboolean

Whether only whole numbers are allowed for amounts set by the client

currencies object[]required

Array of currency configurations for this product

Array [

currencystringrequired

Currency code

Possible values: [USD, AUD, GBP, CAD, CNY, EUR, INR, JPY, AED, CHF, BTC, ETH]

pricenumberrequired

Price in the specified currency

discountnumberrequired

Discount amount

discountUnitstringrequired

Unit for the discount

Possible values: [currency, percentage]

vat object

VAT configuration for this currency

idnumberrequired

Unique identifier of the VAT configuration

Example: 5

namestringrequired

Name/type of the VAT configuration

Possible values: [exempt, incl_low, incl_high, excl_low, excl_high]

percentagenumberrequired

VAT percentage

countrystringrequired

Country code for the VAT

Possible values: [nl, be, de]

includingbooleanrequired

Whether VAT is included in the price

]

productCodestringrequired

Custom identifier for the product

Example: SHOES-123

activebooleanrequired

Whether the product is active

ComponentProductDto

{
  "amount": 1,
  "unit": {
    "id": 1,
    "unitLanguages": [
      {
        "language": "nl",
        "singular": "hour",
        "plural": "hours"
      }
    ],
    "global": true
  },
  "flexibility": "fixed",
  "recurring": "once",
  "optional": true,
  "amountAdjustable": true,
  "minimumAmount": 0,
  "maximumAmount": 1000,
  "wholeNumbers": true,
  "currencies": [
    {
      "currency": "USD",
      "price": 0,
      "discount": 0,
      "discountUnit": "currency",
      "vat": {
        "id": 5,
        "name": "exempt",
        "percentage": 0,
        "country": "nl",
        "including": true
      }
    }
  ],
  "productCode": "SHOES-123",
  "active": true
}