pricings

Add a new pricing to the database.

POST

/pricing

curl --request POST \
  --url https://api-sandbox.timeking.nl/api/external/v1/pricing \
  --header 'X-API-Key: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "active": 123,
  "amount_per_quantity_active": 123,
  "amount_per_quantity_amount": "<string>",
  "applicable_to": [
    "<string>"
  ],
  "bookkeeping_id": "<string>",
  "category_id": 123,
  "combi_rate": 123,
  "created_at": "2023-11-07T05:31:56Z",
  "dates": [
    {}
  ],
  "deleted_at": "2023-11-07T05:31:56Z",
  "external_extras": {},
  "hide_in_app": 123,
  "id": 123,
  "minimum_price_active": 123,
  "minimum_price_price": "<string>",
  "name": "<string>",
  "price": "<string>",
  "price_per": "<string>",
  "purchase_price": "<string>",
  "sort_order": 123,
  "start_price_active": 123,
  "start_price_amount": "<string>",
  "start_price_price": "<string>",
  "task_calculate_for": "<string>",
  "tiers": [
    {
      "amount": 123,
      "price": 123
    }
  ],
  "unit_custom_name": "<string>",
  "unit_id": 123,
  "updated_at": "2023-11-07T05:31:56Z",
  "vat_rate_id": 123
}
'

{
  "data": {
    "pricing": {
      "active": 123,
      "amount_per_quantity_active": 123,
      "amount_per_quantity_amount": "<string>",
      "applicable_to": [
        "<string>"
      ],
      "bookkeeping_id": "<string>",
      "category_id": 123,
      "combi_rate": 123,
      "created_at": "2023-11-07T05:31:56Z",
      "dates": [
        {}
      ],
      "deleted_at": "2023-11-07T05:31:56Z",
      "external_extras": {},
      "hide_in_app": 123,
      "id": 123,
      "minimum_price_active": 123,
      "minimum_price_price": "<string>",
      "name": "<string>",
      "price": "<string>",
      "price_per": "<string>",
      "purchase_price": "<string>",
      "sort_order": 123,
      "start_price_active": 123,
      "start_price_amount": "<string>",
      "start_price_price": "<string>",
      "task_calculate_for": "<string>",
      "tiers": [
        {
          "amount": 123,
          "price": 123
        }
      ],
      "unit_custom_name": "<string>",
      "unit_id": 123,
      "updated_at": "2023-11-07T05:31:56Z",
      "vat_rate_id": 123
    },
    "result": "<string>"
  },
  "status": "<string>"
}

Autorisaties

X-API-Keystringheaderverplicht

Body

Pricing object.

activeinteger

Whether this pricing is a default base rate, applied automatically to the items it is linked to. Returned as 1 (yes) or 0 (no).

amount_per_quantity_activeinteger

Whether a fixed amount per unit applies to this pricing. Returned as 1 (yes) or 0 (no).

amount_per_quantity_amountstring

The amount per unit when amount_per_quantity_active is enabled, as a numeric string.

applicable_tostring[]

Where this pricing can be used, each either 'task', 'sale_rent' (sales & rental) or 'weighing'.

bookkeeping_idstring

The item number of this pricing in the accounting software.

category_idinteger

The ID of the pricing category of this pricing.

combi_rateinteger

Whether this pricing is a combined rate, added only once to the invoice items of a task with linked employees. Returned as 1 (yes) or 0 (no).

created_atstring

The date and time this pricing was created.

datesobject[]

The dates stored on this pricing.

deleted_atstring

The date and time this pricing was archived, or null when it is not archived.

external_extrasobject

Extra accounting data of this pricing synchronized from a connected third-party application, such as 'revenue_type_id' and 'cost_center_id'.

hide_in_appinteger

Whether this pricing is hidden in the app. Returned as 1 (yes) or 0 (no).

idintegerverplicht

The ID of this pricing.

minimum_price_activeinteger

Whether a minimum rate applies to this pricing. Returned as 1 (yes) or 0 (no).

minimum_price_pricestring

The minimum rate in euros when minimum_price_active is enabled. Returned as a numeric string, e.g. "12.50".

namestring

The name of this pricing.

pricestring

The sale price per unit of this pricing in euros, excluding VAT. Returned as a numeric string, e.g. "12.50".

price_perstring

The unit the price is calculated per, either 'hour', 'minute', 'daypart', 'day', 'week', 'month' or 'amount' (quantity).

purchase_pricestring

The cost price per unit of this pricing in euros. Returned as a numeric string, e.g. "12.50".

sort_orderinteger

The position of this pricing in sorted lists.

start_price_activeinteger

Whether a starting rate per quantity applies to this pricing. Returned as 1 (yes) or 0 (no).

start_price_amountstring

The minimum quantity covered by the starting rate. Returned as a numeric string, e.g. "12.50".

start_price_pricestring

The starting rate in euros when start_price_active is enabled. Returned as a numeric string, e.g. "12.50".

task_calculate_forstring

The task time this rate is calculated for, either 'work_time', 'pause_time', 'travel_time', 'travel_time_start', 'travel_time_end', 'repair_time', 'wait_time' or 'travel_time_machine'.

tiersobject[]

The price tiers of this pricing.

child attributes tonen

unit_custom_namestring

The custom unit name when unit_id is set to zero (0).

unit_idinteger

The ID of the unit of this pricing. Set to zero (0) to use unit_custom_name instead.

updated_atstring

The date and time this pricing was last updated.

vat_rate_idinteger

The ID of the VAT rate of this pricing.

Antwoord

Successful operation.

dataobject

The result message and the result data.

child attributes tonen

statusstring

The result status, success.

Nog hulp nodig? Vraag het team