quotes

Add a new quote to the database.

POST

/quote

curl --request POST \
  --url https://api-sandbox.timeking.nl/api/external/v1/quote \
  --header 'X-API-Key: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "_is_accepted": true,
  "_is_declined": true,
  "accepted_at": "2023-11-07T05:31:56Z",
  "accepted_by": "<string>",
  "accepted_by_signature": "<string>",
  "address": "<string>",
  "administration_id": 123,
  "bottom_comment": "<string>",
  "client_id": 123,
  "company": "<string>",
  "confirmed": 123,
  "country": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "custom_user": "<string>",
  "declined_at": "2023-11-07T05:31:56Z",
  "declined_by": "<string>",
  "deleted_at": "2023-11-07T05:31:56Z",
  "due_at": "2023-11-07T05:31:56Z",
  "email": "<string>",
  "export_tasks": 123,
  "export_tasks_options": "<string>",
  "external_ids": {},
  "first_name": "<string>",
  "group_per": [
    "<string>"
  ],
  "hash": "<string>",
  "id": 123,
  "item_blocks": [
    {
      "bottom_comment": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "id": 123,
      "items": [
        {
          "created_at": "2023-11-07T05:31:56Z",
          "customfield1": "<string>",
          "customfield2": "<string>",
          "customfield3": "<string>",
          "customfield4": "<string>",
          "customfield5": "<string>",
          "description": "<string>",
          "discount": "<string>",
          "external_ids": "<string>",
          "from_related": 123,
          "id": 123,
          "item_id": "<string>",
          "item_pricing_id": 123,
          "item_type": "<string>",
          "price": "<string>",
          "pricing_category_id": 123,
          "purchase_price": "<string>",
          "quantity": "<string>",
          "quote_block_id": 123,
          "related_datetime": "2023-11-07T05:31:56Z",
          "related_vat_rate_id": 123,
          "sort_order": 123,
          "tax": "<string>",
          "unit": "<string>",
          "updated_at": "2023-11-07T05:31:56Z"
        }
      ],
      "quote_id": 123,
      "sort_order": 123,
      "top_comment": "<string>",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "last_name": "<string>",
  "name": "<string>",
  "order_id": 123,
  "phone": "<string>",
  "postalcode": "<string>",
  "quote_number": "<string>",
  "reference": "<string>",
  "sent_at": "2023-11-07T05:31:56Z",
  "snelstart_template": "<string>",
  "status": "<string>",
  "status_updated_at": "2023-11-07T05:31:56Z",
  "subcontractor_id": 123,
  "subtotal": "<string>",
  "tax": "<string>",
  "template_id": 123,
  "top_comment": "<string>",
  "total": "<string>",
  "town": "<string>",
  "updated_at": "2023-11-07T05:31:56Z"
}
'

{
  "data": {
    "quote": {
      "accepted_at": "2023-11-07T05:31:56Z",
      "accepted_by": "<string>",
      "accepted_by_signature": "<string>",
      "address": "<string>",
      "administration_id": 123,
      "bottom_comment": "<string>",
      "client_id": 123,
      "company": "<string>",
      "confirmed": 123,
      "country": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "custom_user": "<string>",
      "declined_at": "2023-11-07T05:31:56Z",
      "declined_by": "<string>",
      "deleted_at": "2023-11-07T05:31:56Z",
      "due_at": "2023-11-07T05:31:56Z",
      "email": "<string>",
      "export_tasks": 123,
      "export_tasks_options": "<string>",
      "external_ids": {},
      "first_name": "<string>",
      "group_per": [
        "<string>"
      ],
      "hash": "<string>",
      "id": 123,
      "item_blocks": [
        {
          "bottom_comment": "<string>",
          "created_at": "2023-11-07T05:31:56Z",
          "id": 123,
          "items": [
            {
              "created_at": "2023-11-07T05:31:56Z",
              "customfield1": "<string>",
              "customfield2": "<string>",
              "customfield3": "<string>",
              "customfield4": "<string>",
              "customfield5": "<string>",
              "description": "<string>",
              "discount": "<string>",
              "external_ids": "<string>",
              "from_related": 123,
              "id": 123,
              "item_id": "<string>",
              "item_pricing_id": 123,
              "item_type": "<string>",
              "price": "<string>",
              "pricing_category_id": 123,
              "purchase_price": "<string>",
              "quantity": "<string>",
              "quote_block_id": 123,
              "related_datetime": "2023-11-07T05:31:56Z",
              "related_vat_rate_id": 123,
              "sort_order": 123,
              "tax": "<string>",
              "unit": "<string>",
              "updated_at": "2023-11-07T05:31:56Z"
            }
          ],
          "quote_id": 123,
          "sort_order": 123,
          "top_comment": "<string>",
          "updated_at": "2023-11-07T05:31:56Z"
        }
      ],
      "last_name": "<string>",
      "name": "<string>",
      "order_id": 123,
      "phone": "<string>",
      "postalcode": "<string>",
      "quote_number": "<string>",
      "reference": "<string>",
      "sent_at": "2023-11-07T05:31:56Z",
      "snelstart_template": "<string>",
      "status": "<string>",
      "status_updated_at": "2023-11-07T05:31:56Z",

Body

Quote object.

_is_acceptedboolean

Send true to mark this quote as accepted (setting the status to 'accepted' and the acceptance date), or false to undo the acceptance. Only applied on update; never returned.

_is_declinedboolean

Send true to mark this quote as declined (setting the status to 'declined' and the decline date), or false to undo the decline. Only applied on update; never returned.

accepted_atstring

The date and time this quote was accepted, or empty when it is not accepted.

accepted_bystring

The name of the person who accepted this quote.

accepted_by_signaturestring

The signature of the person who accepted this quote, as image data.

addressstring

The street and house number of the quoted party. Copied from the client when empty.

administration_idinteger

The ID of the administration this quote belongs to, which also determines its quote number series (the default administration's series when empty).

bottom_commentstring

The footnote printed below the quote lines (HTML).

client_idinteger

The ID of the client (klant) this quote is for. Its contact details fill the empty contact fields on save; without a client, fill in company and the other contact fields. A create also needs name.

companystring

The company name of the quoted party. Copied from the client's name when empty.

confirmedinteger

Whether this quote is finalized. Finalizing assigns the quote number; a finalized quote can no longer be deleted. Returned as 1 (yes) or 0 (no).

countrystring

The country of the quoted party, returned as the full country name (falls back to the Netherlands). Accepts an ISO 3166-1 alpha-2 code or a country name; copied from the client when empty.

created_atstring

The date and time this quote was created.

custom_userstring

A legacy free-text user field that is no longer used.

declined_atstring

The date and time this quote was declined, or empty when it is not declined.

declined_bystring

The name of the person who declined this quote.

deleted_atstring

The date and time this quote was archived (soft deleted), or empty when it is not archived.

due_atstring

The date until which this quote is valid.

emailstring

The email address the quote is sent to. Copied from the client when empty.

export_tasksinteger

A legacy export option of this quote that is no longer used. Returned as 1 (yes) or 0 (no).

export_tasks_optionsstring

A legacy export option of this quote that is no longer used.

external_idsobject

The IDs connected to this quote in connected third party applications, keyed by connection.

first_namestring

The first name of the contact person this quote is addressed to.

group_perstring[]

A legacy grouping option of this quote that is no longer used.

hashstring

The random token in the public link of this quote. Generated automatically on create.

idintegerverplicht

The ID of this quote.

item_blocksobject[]

The blocks of quote lines of this quote, in document order.

child attributes tonen

last_namestring

The last name of the contact person this quote is addressed to.

namestring

The name of this quote. Required on create.

order_idinteger

The ID of the order (project) created from this quote.

phonestring

The phone number of the quoted party. Copied from the client when empty.

postalcodestring

The postal code of the quoted party. Copied from the client when empty.

quote_numberstring

The quote number. Assigned automatically from the administration's number series when the quote is finalized (confirmed), and empty while it is a draft.

referencestring

The reference of this quote, printed on the document (max. 50 characters).

sent_atstring

The quote date printed on the document.

snelstart_templatestring

A legacy SnelStart layout option of this quote that is no longer used.

statusstring

The status of this quote, either 'draft', 'confirmed', 'sent', 'accepted' or 'declined'. Always 'draft' on create.

status_updated_atstring

The date and time the status of this quote last changed. Set automatically.

subcontractor_idinteger

The ID of the subcontractor (uitvoerder) of the client this quote is for.

subtotalstring

The total amount excluding VAT in euros as a numeric string. Calculated automatically from the quote lines.

taxstring

The total VAT amount in euros as a numeric string. Calculated automatically from the quote lines.

template_idinteger

The ID of the quote layout used for the document. Defaults to the first quote layout when empty.

top_commentstring

The header comment printed above the quote lines (HTML).

totalstring

The total amount including VAT in euros as a numeric string. Calculated automatically from the quote lines.

townstring

The city of the quoted party. Copied from the client when empty.

updated_atstring

The date and time this quote was last updated.

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

Autorisaties

Body

Antwoord