> For the complete documentation index, see [llms.txt](https://knowledge.out-smart.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://knowledge.out-smart.com/openapi/quotations.md). # Quotations ## Get quotation > This api is used to fetch generated quotations from WorkorderApp.\ > The result can be filtered by using the advanced filter. As described in the introduction section. ```json {"openapi":"3.1.0","info":{"title":"OpenApi","version":"1.0.0"},"servers":[{"url":"{{api_url}}"},{"url":"https://www.werkbonapp.nl"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer"}}},"paths":{"/quotations/":{"get":{"summary":"Get quotation","parameters":[{"name":"token","in":"query","schema":{"type":"string"}},{"name":"software_token","in":"query","schema":{"type":"string"}},{"name":"key","in":"query","schema":{"type":"string"}},{"name":"operator","in":"query","schema":{"type":"string"}},{"name":"value","in":"query","schema":{"type":"integer"}}],"responses":{"200":{"description":"Response_200","headers":{"Date":{"schema":{"type":"string"}},"Server":{"schema":{"type":"string"}},"X-Frame-Options":{"schema":{"type":"string"}},"X-XSS-Protection":{"schema":{"type":"string"}},"X-Content-Type-Options":{"schema":{"type":"string"}},"Strict-Transport-Security":{"schema":{"type":"string"}},"Referrer-Policy":{"schema":{"type":"string"}},"Content-Security-Policy":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}},"Transfer-Encoding":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer"},"messages":{"type":"array"},"response":{"type":"array","items":{"type":"object","properties":{"quo_id":{"type":"string","format":"color"},"quo_qus_id":{"type":"string","format":"utc-millisec"},"quo_quo_id":{"type":"null"},"quo_worksheet_id":{"type":"null"},"quo_project_id":{"type":"null"},"quo_currency_code":{"type":"string"},"quo_currency_symbol":{"type":"string"},"quo_description":{"type":"string"},"quo_quotation_debtor_nr":{"type":"string","format":"utc-millisec"},"quo_quotation_debtor_name":{"type":"string"},"quo_quotation_debtor_email":{"type":"string","format":"email"},"quo_number_numeric":{"type":"string","format":"utc-millisec"},"quo_number_formatted":{"type":"string"},"quo_status":{"type":"string"},"quo_reference":{"type":"string"},"quo_external_reference":{"type":"string"},"quo_date":{"type":"string","format":"date"},"quo_due_date":{"type":"string","format":"date"},"quo_due_days":{"type":"string","format":"utc-millisec"},"quo_header":{"type":"string","format":"style"},"quo_amount":{"type":"string","format":"utc-millisec"},"quo_amount_excl":{"type":"string","format":"utc-millisec"},"quo_user_create":{"type":"string"},"quo_user_mutate":{"type":"string"},"quo_user_send":{"type":"string"},"quo_emp_owner":{"type":"null"},"quo_timestamp_create":{"type":"string","format":"style"},"quo_timestamp_mutate":{"type":"string"},"quo_timestamp_send":{"type":"string","format":"style"},"quo_timestamp_revised":{"type":"null"},"quo_timestamp_executed":{"type":"null"},"quo_timestamp_invoiced":{"type":"null"},"quo_timestamp_declined":{"type":"null"},"quo_timestamp_cancelled":{"type":"null"},"quo_timestamp_accepted":{"type":"null"},"quo_version":{"type":"string","format":"utc-millisec"},"quo_message_declined":{"type":"null"},"quo_message_cancelled":{"type":"null"},"quo_message_accepted":{"type":"string"},"quo_accepted_by":{"type":"null"},"quo_accepted_ip":{"type":"null"},"quo_accepted_signature":{"type":"null"},"quo_adr_code_delivery":{"type":"null"},"quo_cpn_code_delivery":{"type":"null"},"quo_debtor_nr_delivery":{"type":"null"},"quo_cpn_code_invoice":{"type":"null"},"quo_obj_code":{"type":"null"},"quo_substatus":{"type":"null"},"qln_lines":{"type":"array","items":{"type":"object","properties":{"qln_id":{"type":"string","format":"utc-millisec"},"qln_quo_id":{"type":"string","format":"color"},"qln_order":{"type":"string","format":"utc-millisec"},"qln_material_code":{"type":"string"},"qln_material_hourtype":{"type":"null"},"qln_description":{"type":"string"},"qln_note":{"type":"string"},"qln_unit":{"type":"string"},"qln_amount":{"type":"string","format":"utc-millisec"},"qln_price":{"type":"string","format":"utc-millisec"},"qln_vat_percentage":{"type":"string","format":"utc-millisec"},"qln_discount":{"type":"string","format":"utc-millisec"},"qln_total":{"type":"string","format":"utc-millisec"},"qln_total_discount":{"type":"string","format":"utc-millisec"},"qln_total_vat":{"type":"string","format":"utc-millisec"},"qln_total_excl":{"type":"string","format":"utc-millisec"},"qln_total_incl":{"type":"string","format":"utc-millisec"},"qln_freefield_1":{"type":"null"},"qln_freefield_2":{"type":"null"},"qln_freefield_3":{"type":"null"},"qln_freefield_4":{"type":"null"},"qln_freefield_5":{"type":"null"},"qln_hidden":{"type":"string","format":"utc-millisec"},"quo_id":{"type":"string","format":"color"},"quo_cus_id":{"type":"string","format":"utc-millisec"},"quo_qus_id":{"type":"string","format":"utc-millisec"},"quo_quo_id":{"type":"null"},"quo_worksheet_id":{"type":"null"},"quo_qnd_id":{"type":"string","format":"utc-millisec"},"quo_project_id":{"type":"null"},"quo_currency_code":{"type":"string"},"quo_currency_symbol":{"type":"string"},"quo_description":{"type":"string"},"quo_quotation_debtor_nr":{"type":"string","format":"utc-millisec"},"quo_quotation_debtor_name":{"type":"string"},"quo_quotation_debtor_email":{"type":"string","format":"email"},"quo_number_numeric":{"type":"string","format":"utc-millisec"},"quo_number_formatted":{"type":"string"},"quo_status":{"type":"string"},"quo_reference":{"type":"string"},"quo_external_reference":{"type":"string"},"quo_date":{"type":"string","format":"date"},"quo_due_date":{"type":"string","format":"date"},"quo_due_days":{"type":"string","format":"utc-millisec"},"quo_header":{"type":"string","format":"style"},"quo_amount":{"type":"string","format":"utc-millisec"},"quo_amount_excl":{"type":"string","format":"utc-millisec"},"quo_user_create":{"type":"string"},"quo_user_mutate":{"type":"string"},"quo_user_send":{"type":"string"},"quo_emp_owner":{"type":"null"},"quo_timestamp_create":{"type":"string","format":"style"},"quo_timestamp_mutate":{"type":"string"},"quo_timestamp_send":{"type":"string","format":"style"},"quo_timestamp_revised":{"type":"null"},"quo_timestamp_executed":{"type":"null"},"quo_timestamp_invoiced":{"type":"null"},"quo_timestamp_declined":{"type":"null"},"quo_timestamp_cancelled":{"type":"null"},"quo_timestamp_accepted":{"type":"null"},"quo_version":{"type":"string","format":"utc-millisec"},"quo_message_declined":{"type":"null"},"quo_message_cancelled":{"type":"null"},"quo_message_accepted":{"type":"string"},"quo_accepted_by":{"type":"null"},"quo_accepted_ip":{"type":"null"},"quo_accepted_signature":{"type":"null"},"quo_adr_code_delivery":{"type":"null"},"quo_cpn_code_delivery":{"type":"null"},"quo_debtor_nr_delivery":{"type":"null"},"quo_cpn_code_invoice":{"type":"null"},"quo_obj_code":{"type":"null"},"quo_substatus":{"type":"null"},"id":{"type":"string","format":"utc-millisec"},"customerid":{"type":"string","format":"utc-millisec"},"ref_id":{"type":"string"},"uom_name":{"type":"string"},"Artikelcode":{"type":"string"},"Omschrijving":{"type":"string"},"Stukprijs":{"type":"string","format":"utc-millisec"},"Unit":{"type":"string"},"Barcode":{"type":"string"},"IsInternal":{"type":"string","format":"utc-millisec"},"EANCode":{"type":"string"},"VATCode":{"type":"string"},"FreeField1":{"type":"null"},"FreeField2":{"type":"null"},"FreeField3":{"type":"null"},"FreeField4":{"type":"null"},"FreeField5":{"type":"null"},"Image":{"type":"string"},"Note":{"type":"string"},"created_at":{"type":"string","format":"style"},"updated_at":{"type":"string"}}}},"quotation_debtor":{"type":"object","properties":{"qnd_name":{"type":"string"},"qnd_debiteur_number":{"type":"string","format":"utc-millisec"},"qnd_street":{"type":"string"},"qnd_zip":{"type":"string"},"qnd_city":{"type":"string"},"qnd_country":{"type":"string"},"qnd_contact":{"type":"string"},"qnd_phone":{"type":"string"},"qnd_email":{"type":"string","format":"email"},"qnd_extra":{"type":"string"},"qnd_external_id":{"type":"string"},"qnd_latitude":{"type":"string"},"qnd_longitude":{"type":"string"}}},"pdf":{"type":"string","format":"uri"},"url":{"type":"string","format":"uri"}}}}}}}}}},"tags":["Quotations"],"description":"This api is used to fetch generated quotations from WorkorderApp.\nThe result can be filtered by using the advanced filter. As described in the introduction section."}}}} ``` ## Post quotation (BETA) > \### Create Quotation\ > \ > \_\*\*BETA:\*\*\_ \_Will be released in\_ \_\*\*4.2.0\*\*\_\ > \ > This endpoint allows the client to create a new quotation by making an HTTP POST request to the specified URL.\ > \ > \#### Request Body\ > \ > \- \*\*\`quo\_quotation\_debtor\_nr\`\*\* (text, optional): The debtor number for the quotation.\ > \ > \- \*\*\`options\`\*\* (object):\ > \ > \- \*\*\`mark\_as\_sent\`\*\* (boolean): Indicates whether the quotation should be marked as sent.\ > \ > \- \*\*\`send\_email\`\*\* (boolean): Indicates whether an email should be sent.\ > \ > \- \*\*\`note\`\*\* (text, optional): Additional note for the quotation.\ > \ > \- \*\*\`qln\_lines\`\*\* (array):\ > \ > \- \*\*\`qln\_note\`\*\* (text, optional): Note for the quotation line.\ > \ > \- \*\*\`quo\_currency\_code\`\*\* (text, required): The currency code for the quotation. Falls back to scheme's currency code if not provided.\ > \ > \- \*\*\`quo\_currency\_symbol\`\*\* (text, required): The currency symbol for the quotation. Falls back to scheme's currency symbol if not provided.\ > \ > \- \*\*\`quo\_description\`\*\* (text, optional): Description of the quotation. Falls back to scheme's description if not provided.\ > \ > \- \*\*\`quo\_header\`\*\* (text, optional): Header of the quotation. Generated based on the customer ID and the layout if not provided.\ > \ > \- \*\*\`quo\_due\_days\`\*\* (number, optional): The number of due days for the quotation. Falls back to scheme's due days if not provided.\ > \ > \- \*\*\`quo\_date\`\*\* (date, optional): The date of the quotation. Defaults to the current date if not provided.\ > \ > \- \*\*\`tax\_calculation\_method\`\*\* (text, required): The method for tax calculation. Defaults to 'EXCLUDING' if not a valid option ('EXCLUDING', 'INCLUDING').\ > \ > \ > \#### Additional Parameters\ > \ > \- \*\*\`quo\_obj\_code\`\*\* (text, optional): Object code of the quotation.\ > \ > \- \*\*\`quo\_cpn\_code\_invoice\`\*\* (text, optional): Coupon code for invoicing.\ > \ > \- \*\*\`quo\_debtor\_nr\_delivery\`\*\* (text, optional): Debtor number for delivery.\ > \ > \- \*\*\`quo\_cpn\_code\_delivery\`\*\* (text, optional): Coupon code for delivery.\ > \ > \- \*\*\`quo\_adr\_code\_delivery\`\*\* (text, optional): Address code for delivery.\ > \ > \- \*\*\`quo\_project\_id\`\*\* (text, optional): Project ID associated with the quotation.\ > \ > \- \*\*\`quo\_reference\`\*\* (text, optional): Reference for the quotation.\ > \ > \- \*\*\`quo\_emp\_owner\`\*\* (text, optional): Employee owner of the quotation.\ > \ > \- \*\*\`quo\_substatus\`\*\* (text, optional): Substatus of the quotation.\ > \ > \ > \### Expected Response\ > \ > The API returns a JSON object with the following fields:\ > \ > \- \*\*\`code\`\*\* (number): The status code of the response.\ > \ > \- \*\*\`messages\`\*\* (array): An array of messages, if any.\ > \ > \- \*\*\`response\`\*\* (object): The response data, which may include detailed information about the created quotation or may be null in case of an error.\ > \ > \ > In case of a successful request, the expected response code is 200 with a \`response\` object containing information about the newly created quotation. If there are errors in the request, such as missing required fields, the response code will differ, and the \`messages\` array will contain details about the errors encountered. ```json {"openapi":"3.1.0","info":{"title":"OpenApi","version":"1.0.0"},"servers":[{"url":"{{api_url}}"},{"url":"https://www.werkbonapp.nl"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer"}}},"paths":{"/quotations/":{"post":{"summary":"Post quotation (BETA)","parameters":[{"name":"token","in":"query","schema":{"type":"string"}},{"name":"software_token","in":"query","schema":{"type":"string"}}],"responses":{},"tags":["Quotations"],"description":"### Create Quotation\n\n_**BETA:**_ _Will be released in_ _**4.2.0**_\n\nThis endpoint allows the client to create a new quotation by making an HTTP POST request to the specified URL.\n\n#### Request Body\n\n- **`quo_quotation_debtor_nr`** (text, optional): The debtor number for the quotation.\n \n- **`options`** (object):\n \n - **`mark_as_sent`** (boolean): Indicates whether the quotation should be marked as sent.\n \n - **`send_email`** (boolean): Indicates whether an email should be sent.\n \n - **`note`** (text, optional): Additional note for the quotation.\n \n- **`qln_lines`** (array):\n \n - **`qln_note`** (text, optional): Note for the quotation line.\n \n- **`quo_currency_code`** (text, required): The currency code for the quotation. Falls back to scheme's currency code if not provided.\n \n- **`quo_currency_symbol`** (text, required): The currency symbol for the quotation. Falls back to scheme's currency symbol if not provided.\n \n- **`quo_description`** (text, optional): Description of the quotation. Falls back to scheme's description if not provided.\n \n- **`quo_header`** (text, optional): Header of the quotation. Generated based on the customer ID and the layout if not provided.\n \n- **`quo_due_days`** (number, optional): The number of due days for the quotation. Falls back to scheme's due days if not provided.\n \n- **`quo_date`** (date, optional): The date of the quotation. Defaults to the current date if not provided.\n \n- **`tax_calculation_method`** (text, required): The method for tax calculation. Defaults to 'EXCLUDING' if not a valid option ('EXCLUDING', 'INCLUDING').\n \n\n#### Additional Parameters\n\n- **`quo_obj_code`** (text, optional): Object code of the quotation.\n \n- **`quo_cpn_code_invoice`** (text, optional): Coupon code for invoicing.\n \n- **`quo_debtor_nr_delivery`** (text, optional): Debtor number for delivery.\n \n- **`quo_cpn_code_delivery`** (text, optional): Coupon code for delivery.\n \n- **`quo_adr_code_delivery`** (text, optional): Address code for delivery.\n \n- **`quo_project_id`** (text, optional): Project ID associated with the quotation.\n \n- **`quo_reference`** (text, optional): Reference for the quotation.\n \n- **`quo_emp_owner`** (text, optional): Employee owner of the quotation.\n \n- **`quo_substatus`** (text, optional): Substatus of the quotation.\n \n\n### Expected Response\n\nThe API returns a JSON object with the following fields:\n\n- **`code`** (number): The status code of the response.\n \n- **`messages`** (array): An array of messages, if any.\n \n- **`response`** (object): The response data, which may include detailed information about the created quotation or may be null in case of an error.\n \n\nIn case of a successful request, the expected response code is 200 with a `response` object containing information about the newly created quotation. If there are errors in the request, such as missing required fields, the response code will differ, and the `messages` array will contain details about the errors encountered.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"quo_quotation_debtor_nr":{"type":"string","format":"utc-millisec"},"options":{"type":"object","properties":{"mark_as_sent":{"type":"boolean"},"send_email":{"type":"boolean"},"note":{"type":"string"}}},"qln_lines":{"type":"array","items":{"type":"object","properties":{"qln_note":{"type":"string"}}}}}}}}}}}}} ``` ## PUT /quotations/ > Update quotation ```json {"openapi":"3.1.0","info":{"title":"OpenApi","version":"1.0.0"},"servers":[{"url":"{{api_url}}"},{"url":"https://www.werkbonapp.nl"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer"}}},"paths":{"/quotations/":{"put":{"summary":"Update quotation","parameters":[{"name":"token","in":"query","schema":{"type":"string"}},{"name":"software_token","in":"query","schema":{"type":"string"}},{"name":"quo_id","in":"query","description":"Quotation ID is required","schema":{"type":"integer"}},{"name":"quo_external_reference","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Response_200","headers":{"Date":{"schema":{"type":"string"}},"Server":{"schema":{"type":"string"}},"X-Frame-Options":{"schema":{"type":"string"}},"X-XSS-Protection":{"schema":{"type":"string"}},"X-Content-Type-Options":{"schema":{"type":"string"}},"Strict-Transport-Security":{"schema":{"type":"string"}},"Referrer-Policy":{"schema":{"type":"string"}},"Content-Security-Policy":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}},"Content-Length":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer"},"messages":{"type":"array","items":{"type":"string"}},"response":{"type":"null"}}}}}}},"tags":["Quotations"]}}}} ``` --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://knowledge.out-smart.com/openapi/quotations.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.