Skip to main content

UpdateComponentBodyDto

namestring

The name of the component

categoryIdnumber

The category ID

Example: 1
languagestring

Language of the component

Possible values: [nl, en, de]

product object

Product configuration for this component

amountnumber

Quantity/amount of the product

unitIdnumber

Id of the unit used in the product

Example: 1
flexibilitystring

Flexibility setting for the product

Possible values: [fixed, provisional, estimate]

recurringstring

Recurring billing frequency

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

productCodestring

Unique custom identifier for the product

Example: COMPONENT-123
activeboolean

Whether the product is active

optionalboolean

Whether the product is optional

amountAdjustableboolean

Whether the amount is adjustable by the client

minimumAmountnumber

Minimum allowed amount (when amountAdjustable is true)

maximumAmountnumber

Maximum allowed amount (when amountAdjustable is true)

wholeNumbersboolean

Whether only whole numbers are allowed (when amountAdjustable is true)

currencies object[]

Array of currency configurations for this product, currencies must also be available in the workspace settings

  • Array [
  • currencystring

    Currency code

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

    pricenumber

    Price in the specified currency

    Example: 2495
    vatIdnumber

    VAT id for this currency

    Example: 5
    discountnumber

    Discount amount

    discountUnitstring

    Unit for the discount

    Possible values: [percentage, currency]

  • ]
  • UpdateComponentBodyDto
    {
    "name": "string",
    "categoryId": 1,
    "language": "nl",
    "product": {
    "amount": 0,
    "unitId": 1,
    "flexibility": "fixed",
    "recurring": "once",
    "productCode": "COMPONENT-123",
    "active": true,
    "optional": true,
    "amountAdjustable": true,
    "minimumAmount": 0,
    "maximumAmount": 0,
    "wholeNumbers": true,
    "currencies": [
    {
    "currency": "USD",
    "price": 2495,
    "vatId": 5,
    "discount": 0,
    "discountUnit": "percentage"
    }
    ]
    }
    }