{"info":{"_postman_id":"80ee0825-9541-49ec-97b7-051e1786e12a","name":"Booking & Schema Online - API","description":"

Getting Started:

\n

To begin using our APIs, please follow the steps below:

\n

1. Signup: To access our APIs, you must first sign up on the Booking & Schema online platform.

\n

2. Upgrade: After signing up, you will receive a 14-day trial. However, please note that this feature is only available to paid companies. Therefore, you will need to sign a contract to upgrade and gain access to our APIs.

\n

3. Activate API: Once you have upgraded, you can activate the API from the settings page. Make sure to copy the secret and token before closing the dialog, as it will only be visible once.

\n

Note
It's important to note that our API directly communicates with your actual account on the Booking & Schema online platform. This means that any changes made using the endpoints will affect the actual objects in your account. Please be aware that a sandbox version for development and testing will be available soon.

\n

How to Use Secret and Token:
Each requests sent to Booking and Schema online api must contain the token and secret in the request headers for authorization:

\n\n

If you have any queries please drop us an email at: developer@birdvision.se

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"8776371","collectionId":"80ee0825-9541-49ec-97b7-051e1786e12a","publishedId":"2s93Jrw4hV","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2023-03-10T04:40:28.000Z"},"item":[{"name":"Services","item":[{"name":"Create Services","id":"28c836be-1407-448f-9676-08ada01ffad6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{opentoken}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Secret","value":"{{secret}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"title\": \"\", // Required, type: string, limite: 255, accept: string, decription: Title of the service to be created.\n \"description\": \"\", // Required, type: string, limite: 255, accept: string, decription: Description of the service to be created.\n \"is_active\": true // Optional, type: boolean, accept: boolean, decription: To set created service activated.\n}","options":{"raw":{"language":"json"}}},"url":"{{baseURL}}/services","urlObject":{"path":["services"],"host":["{{baseURL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"28c836be-1407-448f-9676-08ada01ffad6"},{"name":"Update Services","id":"3319670a-ca01-46b8-bcf0-ac4a293835da","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"PUT","header":[{"key":"Secret","value":"{{secret}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"title\": \"\", // Required, type: string, limite: 255, accept: string, decription: Title of the service to be updated.\n \"description\": \"\", // Optional, type: string, limite: 255, accept: string, decription: Description of the service to be updated.\n \"is_active\": true // Optional, type: boolean, accept: boolean, decription: To set created service updated.\n}","options":{"raw":{"language":"json"}}},"url":"{{baseURL}}/services/:id","urlObject":{"path":["services",":id"],"host":["{{baseURL}}"],"query":[],"variable":[{"description":{"content":"

Service 'id' required for updating particular service details.

\n","type":"text/plain"},"type":"any","value":"Any existing service id","key":"id"}]}},"response":[],"_postman_id":"3319670a-ca01-46b8-bcf0-ac4a293835da"},{"name":"Delete Services","id":"f7344986-c21e-456a-8cf9-00315c82372e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"DELETE","header":[{"key":"Secret","value":"{{secret}}","type":"text"}],"url":"{{baseURL}}/services/:id","urlObject":{"path":["services",":id"],"host":["{{baseURL}}"],"query":[],"variable":[{"description":{"content":"

Service 'id' required for deleting particular service details.

\n","type":"text/plain"},"type":"any","value":"Any existing service id","key":"id"}]}},"response":[],"_postman_id":"f7344986-c21e-456a-8cf9-00315c82372e"},{"name":"Service list","id":"48512188-fe82-4e51-aa94-4dd05a65a285","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Secret","value":"{{secret}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{baseURL}}/services?page=1&per_page=10&title=","urlObject":{"path":["services"],"host":["{{baseURL}}"],"query":[{"description":{"content":"

Page no of record

\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"

Limit 100 record per page base value 30

\n","type":"text/plain"},"key":"per_page","value":"10"},{"description":{"content":"

Filter by service title

\n","type":"text/plain"},"key":"title","value":""}],"variable":[]}},"response":[],"_postman_id":"48512188-fe82-4e51-aa94-4dd05a65a285"},{"name":"Show Service","id":"2fb3b24b-159a-441a-b410-256b082c5c95","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Secret","value":"{{secret}}","type":"text"}],"url":"{{baseURL}}/services/:id","urlObject":{"path":["services",":id"],"host":["{{baseURL}}"],"query":[],"variable":[{"description":{"content":"

Service 'id' required for getting particular service details

\n","type":"text/plain"},"type":"any","value":"Any existing service id","key":"id"}]}},"response":[],"_postman_id":"2fb3b24b-159a-441a-b410-256b082c5c95"}],"id":"9cc4a852-0e4f-47ee-9d09-4e8910227c7f","_postman_id":"9cc4a852-0e4f-47ee-9d09-4e8910227c7f","description":""},{"name":"Customers","item":[{"name":"Show Customer","id":"cd0515d2-2aca-4793-b56d-b1aabed7e57e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Secret","value":"{{secret}}","type":"text"}],"url":"{{baseURL}}/customers/:id","urlObject":{"path":["customers",":id"],"host":["{{baseURL}}"],"query":[],"variable":[{"description":{"content":"

Customer 'id' required for getting particular customer details.

\n","type":"text/plain"},"type":"any","value":"Any existing customer id","key":"id"}]}},"response":[],"_postman_id":"cd0515d2-2aca-4793-b56d-b1aabed7e57e"},{"name":"Create Customer","id":"810eb2dd-95be-4bf5-a013-063d543318a2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Secret","value":"{{secret}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"customer\": {\n \"name\": \"\", // Required, type: string, limite: 255, accept: string, decription: Customer name.\n \"contact_name\": \"\", // Optional, type: string, limite: 255, accept: string, decription: Customer contact name.\n \"customer_number\": \"\", // Optional, type: string, limite: 255, accept: string, decription: Customer customer number.\n \"email\": \"\", // Optional, type: string, limite: 255, accept: string, decription: Customer email.\n \"invoice_email\": \"\", // Optional, type: string, limite: 255, accept: string, decription: Customer invoice email.\n \"mobile\": \"\", // Optional, type: string, limite: 255, accept: string, decription: Customer mobile.\n \"telephone\": \"\", // Optional, type: string, limite: 255, accept: string, decription: Customer telephone.\n \"address\": \"\" , // Optional, type: string, limite: 255, accept: string, decription: Customer address.\n \"door_code\": \"\", // Optional, type: string, limite: 255, accept: string, decription: Customer door code.\n \"is_organisation\": \"\", // Optional, type: boolean, accept: boolean, decription: Customer is organisation or individual.\n \"vat_included\": \"\" // Optional, type: boolean, accept: boolean, decription: Customer's vat included.\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{baseURL}}/customers","urlObject":{"path":["customers"],"host":["{{baseURL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"810eb2dd-95be-4bf5-a013-063d543318a2"},{"name":"Update Customer","id":"a6ebb299-7ec4-41cc-b6d6-dc5ce32e9b11","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{opentoken}}"}]},"isInherited":false},"method":"PUT","header":[{"key":"Secret","value":"{{secret}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"customer\": {\n \"name\": \"\", // Required, type: string, limit: 255, accept: string, decription: Customer name.\n \"contact_name\": \"\", // Optional, type: string, limit: 255, accept: string, decription: Customer contact name.\n \"customer_number\": \"\", // Optional, type: string, limit: 255, accept: string, decription: Customer customer number.\n \"email\": \"\", // Optional, type: string, limit: 255, accept: string, decription: Customer email.\n \"invoice_email\": \"\", // Optional, type: string, limite: 255, accept: string, decription: Customer invoice email.\n \"mobile\": \"\", // Optional, type: string, limit: 255, accept: string, decription: Customer mobile.\n \"telephone\": \"\", // Optional, type: string, limit: 255, accept: string, decription: Customer telephone.\n \"address\": \"\", // Optional, type: string, limit: 255, accept: string, decription: Customer address.\n \"zip_code\": \"\", // Optional, type: string, limit: 255, accept: string, decription: Customer address.\n \"area\": \"\", // Optional, type: string, limit: 255, accept: string, decription: Customer address.\n \"vat_number\": \"\", // Optional, type: string, limit: 255, accept: string, decription: Customer address.\n \"door_code\": \"\", // Optional, type: string, limit: 255, accept: string, decription: Customer door code.\n \"is_organisation\": \"\", // Optional, type: boolean, accept: boolean, decription: Customer is organisation or individual.\n \"vat_included\": \"\" // Optional, type: boolean, accept: boolean, decription: Customer's vat included.\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{baseURL}}/customers/:id","urlObject":{"path":["customers",":id"],"host":["{{baseURL}}"],"query":[],"variable":[{"description":{"content":"

Customer 'id' required for updating particular customer details.

\n","type":"text/plain"},"type":"any","value":"d05a1eeed78d686bb84fe1e3131a15","key":"id"}]}},"response":[],"_postman_id":"a6ebb299-7ec4-41cc-b6d6-dc5ce32e9b11"},{"name":"Delete Customer","id":"33eabffd-f849-4fdf-98d0-f5ab7bd3058e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"DELETE","header":[{"key":"Secret","value":"{{secret}}","type":"text"}],"url":"{{baseURL}}/customers/:id","urlObject":{"path":["customers",":id"],"host":["{{baseURL}}"],"query":[],"variable":[{"description":{"content":"

Customer 'id' required for deleting particular customer details.

\n","type":"text/plain"},"type":"any","value":"Any existing customer id","key":"id"}]}},"response":[],"_postman_id":"33eabffd-f849-4fdf-98d0-f5ab7bd3058e"},{"name":"Custome List","id":"8fa4131c-d7e9-4e0c-b547-ed4e6bcd8ac1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Secret","value":"{{secret}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{baseURL}}/customers?page=1&per_page=10&name=&customer_number=","urlObject":{"path":["customers"],"host":["{{baseURL}}"],"query":[{"description":{"content":"

Page no of record

\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"

Limit 100 record per page base value 30

\n","type":"text/plain"},"key":"per_page","value":"10"},{"description":{"content":"

Filter by customer's name

\n","type":"text/plain"},"key":"name","value":""},{"description":{"content":"

Filter by customer's number

\n","type":"text/plain"},"key":"customer_number","value":""}],"variable":[]}},"response":[],"_postman_id":"8fa4131c-d7e9-4e0c-b547-ed4e6bcd8ac1"}],"id":"55cb5afe-97dd-407c-bbe7-6326aac2d10d","_postman_id":"55cb5afe-97dd-407c-bbe7-6326aac2d10d","description":""},{"name":"Employees","item":[{"name":"Employee list","id":"8d3ab6c5-8a17-4bff-84eb-5887a4e6e29f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Secret","value":"{{secret}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{baseURL}}/employees?page=1&per_page=10&name=","urlObject":{"path":["employees"],"host":["{{baseURL}}"],"query":[{"description":{"content":"

Page no of record

\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"

Limit 100 record per page base value 30

\n","type":"text/plain"},"key":"per_page","value":"10"},{"description":{"content":"

Filter by employee name

\n","type":"text/plain"},"key":"name","value":""}],"variable":[]}},"response":[],"_postman_id":"8d3ab6c5-8a17-4bff-84eb-5887a4e6e29f"},{"name":"Show Employee","id":"c5a77c8b-88ed-419e-9a47-8595a88e5720","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Secret","value":"{{secret}}","type":"text"}],"url":"{{baseURL}}/employees/:id","urlObject":{"path":["employees",":id"],"host":["{{baseURL}}"],"query":[],"variable":[{"description":{"content":"

Employee 'id' required for getting particular employee details.

\n","type":"text/plain"},"type":"any","value":"Any existing employee id","key":"id"}]}},"response":[],"_postman_id":"c5a77c8b-88ed-419e-9a47-8595a88e5720"},{"name":"Create Employee","id":"6d3b0bba-2c87-4b08-82ed-e47b892fea92","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Secret","value":"{{secret}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"employee\": {\n \"name\": \"\", // Required, type: string, limite: 255, accept: string, decription: Employee name.\n \"identification_num\": \"\", // Optional, type: string, limite: 255, accept: string, decription: Employee identification num.\n \"email\": \"\", // Required, type: string, limite: 255, accept: string, decription: Employee login email. \n \"employee_number\": \"\", // Optional, type: string, limite: 255, accept: string, decription: Employee employee number.\n \"mobile\": \"\", // Optional, type: string, limite: 255, accept: string, decription: Employee mobile.\n \"phone\": \"\", // Optional, type: string, limite: 255, accept: string, decription: Employee phone.\n \"address\": \"\", // Optional, type: string, limite: 255, accept: string, decription: Employee address.\n \"area\": \"\", // Optional, type: string, limite: 255, accept: string, decription: Employee area.\n \"zip_code\": \"\", // Optional, type: string, limite: 255, accept: string, decription: Employee zip code.\n \"salary_type\": \"\", // Required, type: string, limit: 255, allowed values: 'TID' or 'ARB', description: Salary type.\n \"send_employee_login_details\": \"\" // Optional, type: boolean, allowed values: true or false, description: Whether to send login details to the employee.\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{baseURL}}/employees","urlObject":{"path":["employees"],"host":["{{baseURL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"6d3b0bba-2c87-4b08-82ed-e47b892fea92"},{"name":"Update Employee","id":"9f071663-d1fd-4160-ba20-d6c1fcd8f67d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"PUT","header":[{"key":"Secret","value":"{{secret}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"employee\": {\n \"name\": \"\", // Required, type: string, limite: 255, accept: string, decription: Employee name.\n \"identification_num\": \"\", // Optional, type: string, limite: 255, accept: string, decription: Employee identification num.\n \"employee_number\": \"\", // Optional, type: string, limite: 255, accept: string, decription: Employee employee number.\n \"mobile\": \"\", // Optional, type: string, limite: 255, accept: string, decription: Employee mobile.\n \"phone\": \"\", // Optional, type: string, limite: 255, accept: string, decription: Employee phone.\n \"address\": \"\", // Optional, type: string, limite: 255, accept: string, decription: Employee address.\n \"area\": \"\", // Optional, type: string, limite: 255, accept: string, decription: Employee area.\n \"zip_code\": \"\", // Optional, type: string, limite: 255, accept: string, decription: Employee zip code.\n \"salary_type\": \"\" // Required, type: string, limit: 255, allowed values: 'TID' or 'ARB', description: Salary type.\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{baseURL}}/employees/:id","urlObject":{"path":["employees",":id"],"host":["{{baseURL}}"],"query":[],"variable":[{"description":{"content":"

Employee 'id' required for updating particular employee details.

\n","type":"text/plain"},"type":"any","value":"Any existing employee id","key":"id"}]}},"response":[],"_postman_id":"9f071663-d1fd-4160-ba20-d6c1fcd8f67d"},{"name":"Delete Employee","id":"aeab3e2a-228b-43fd-bdb3-5ff0ed2ebbfd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"DELETE","header":[{"key":"Secret","value":"{{secret}}","type":"text"}],"url":"{{baseURL}}/employees/:id","urlObject":{"path":["employees",":id"],"host":["{{baseURL}}"],"query":[],"variable":[{"description":{"content":"

Employee 'id' required for deleting particular employee details.

\n","type":"text/plain"},"type":"any","value":"Any existing employee id","key":"id"}]}},"response":[],"_postman_id":"aeab3e2a-228b-43fd-bdb3-5ff0ed2ebbfd"},{"name":"Update Employee Login Email","id":"a89a015e-c825-4b2b-8491-04c32c199b76","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Secret","value":"{{secret}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"employee\": {\r\n \"email\": \"\" // Required, type: string, limite: 255, accept: string, decription: Employee login email.\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"{{baseURL}}/employees/:id/update_login_email","urlObject":{"path":["employees",":id","update_login_email"],"host":["{{baseURL}}"],"query":[],"variable":[{"description":{"content":"

Employee 'id' required for getting particular employee details.

\n","type":"text/plain"},"type":"any","value":"Any existing employee id","key":"id"}]}},"response":[],"_postman_id":"a89a015e-c825-4b2b-8491-04c32c199b76"}],"id":"68b4a374-14b4-408d-9454-3016c351edf9","_postman_id":"68b4a374-14b4-408d-9454-3016c351edf9","description":""},{"name":"Items","item":[{"name":"Show Item","id":"436372ff-f86c-4f72-be1e-687ff5cb0a94","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Secret","value":"{{secret}}","type":"text"}],"url":"{{baseURL}}/items/:id","urlObject":{"path":["items",":id"],"host":["{{baseURL}}"],"query":[],"variable":[{"description":{"content":"

Item 'id' required for getting particular item details.

\n","type":"text/plain"},"type":"any","value":"Any existing item id","key":"id"}]}},"response":[],"_postman_id":"436372ff-f86c-4f72-be1e-687ff5cb0a94"},{"name":"Item List","id":"e679904c-470f-4f94-a955-7ae73126b0f5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{opentoken}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Secret","value":"{{secret}}","type":"text"}],"url":"{{baseURL}}/items?page=1&per_page=&title=&visma_items=true","urlObject":{"path":["items"],"host":["{{baseURL}}"],"query":[{"description":{"content":"

Page no of record

\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"

Limit 100 record per page base value 30

\n","type":"text/plain"},"key":"per_page","value":""},{"description":{"content":"

Filter by item's title

\n","type":"text/plain"},"key":"title","value":""},{"description":{"content":"

Filter to get only visma items

\n","type":"text/plain"},"key":"visma_items","value":"true"}],"variable":[]}},"response":[],"_postman_id":"e679904c-470f-4f94-a955-7ae73126b0f5"},{"name":"Create Item","id":"60ebb322-be37-4de2-85ec-fb86ebbffb2d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Secret","value":"{{secret}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"item\": {\n \"title\": \"\", // Required, type: string, limite: 255, accept: string, decription: Item title.\n \"unit\": \"\", // Required, type: string, limite: 255, accept: string, decription: Item unit.\n \"vat\": \"\", // Required, type: integer, limite: 100, accept: integer, decription: Item vat.\n \"excl_vat_per_unit\": \"\", // Required, type: float, accept: float, description: Price per unit excluding VAT.\n \"incl_vat_per_unit\": \"\" // Required, type: float, accept: float, description: Price per unit including VAT.\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{baseURL}}/items","description":"

For 'unit' attribute allowed values are:
'tim', 'km', 'st', 'utl', 'kvm', 'förp'

\n

For 'vat' attribute allowed values are:

\n

0, 6, 12, 25

\n","urlObject":{"path":["items"],"host":["{{baseURL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"60ebb322-be37-4de2-85ec-fb86ebbffb2d"},{"name":"Update Item","id":"05ec5ee0-0571-4795-bdbb-fdb1fe252277","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"PUT","header":[{"key":"Secret","value":"{{secret}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"item\": {\n \"title\": \"\", // Required, type: string, limite: 255, accept: string, decription: Item title.\n \"unit\": \"\", // Optional, type: string, limite: 255, accept: string, decription: Item unit.\n \"vat\": \"\", // Required, type: integer, limite: 100, accept: integer, decription: Item vat.\n \"excl_vat_per_unit\": \"\", // Required, type: float, accept: float, description: Price per unit excluding VAT.\n \"incl_vat_per_unit\": \"\" // Required, type: float, accept: float, description: Price per unit including VAT.\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{baseURL}}/items/:id","description":"

For 'unit' attribute allowed values are:
'tim', 'km', 'st', 'utl', 'kvm', 'förp'

\n

For 'vat' attribute allowed values are:

\n

0, 6, 12, 25

\n","urlObject":{"path":["items",":id"],"host":["{{baseURL}}"],"query":[],"variable":[{"description":{"content":"

Item 'id' required for updating particular item details.

\n","type":"text/plain"},"type":"any","value":"Any existing item id","key":"id"}]}},"response":[],"_postman_id":"05ec5ee0-0571-4795-bdbb-fdb1fe252277"},{"name":"Delete Item","id":"ff6c328b-bfcf-49bc-88a6-c38b033c5794","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"DELETE","header":[{"key":"Secret","value":"{{secret}}","type":"text"}],"url":"{{baseURL}}/items/:id","urlObject":{"path":["items",":id"],"host":["{{baseURL}}"],"query":[],"variable":[{"description":{"content":"

Item 'id' required for deleting particular item details.

\n","type":"text/plain"},"type":"any","value":"Any existing item id","key":"id"}]}},"response":[],"_postman_id":"ff6c328b-bfcf-49bc-88a6-c38b033c5794"}],"id":"68b9aa51-a861-4299-befd-44bc22fb5843","_postman_id":"68b9aa51-a861-4299-befd-44bc22fb5843","description":""},{"name":"Order","item":[{"name":"Show Order","id":"72371fc6-e6ea-4d40-bb9e-0889eea9170b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{opentoken}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Secret","value":"{{secret}}","type":"text"}],"url":"{{baseURL}}/orders/:id","urlObject":{"path":["orders",":id"],"host":["{{baseURL}}"],"query":[],"variable":[{"description":{"content":"

Order 'id' required for getting particular order details

\n","type":"text/plain"},"type":"any","value":"Any existing order id","key":"id"}]}},"response":[],"_postman_id":"72371fc6-e6ea-4d40-bb9e-0889eea9170b"},{"name":"Order list","id":"9797a5b2-93d5-4823-a45c-90d0365e240f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{opentoken}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Secret","value":"{{secret}}","type":"text"}],"url":"{{baseURL}}/orders?start_date=&end_date=&page=1&per_page=100&project_id=&customer_id=&service_id=&employee_id=","description":"

This endpoint list the order within a certain date range and according to filter params provided.
There are two categories of orders
1. order with id
2. order without id (virtual order)

\n

Params:

\n
    \n
  1. start_date (Required, Type: String)
    2. \n
  2. end_date (Required, Type: String)
    3. \n
  3. page (Optional, Type: Integer)
    4. \n
  4. per_page (Optional, Type: Interger, Limit: 100)
    5. \n
  5. project_id (Optional, Type: Integer) pass project's sequence_num
    6. \n
  6. customer_id (Optional, Type: String)
    7. \n
  7. service_id (Optional, Type: Strng)
    8. \n
  8. employee_id(Optional, Type: String)
    9. \n
\n","urlObject":{"path":["orders"],"host":["{{baseURL}}"],"query":[{"description":{"content":"

Filter by start date

\n","type":"text/plain"},"key":"start_date","value":""},{"description":{"content":"

Filter by end date

\n","type":"text/plain"},"key":"end_date","value":""},{"description":{"content":"

Page no of record

\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"

Limit 100 record per page base value 30

\n","type":"text/plain"},"key":"per_page","value":"100"},{"description":{"content":"

Filter by project sequence_num

\n","type":"text/plain"},"key":"project_id","value":""},{"description":{"content":"

Filter by customer id

\n","type":"text/plain"},"key":"customer_id","value":""},{"description":{"content":"

Filter by service id

\n","type":"text/plain"},"key":"service_id","value":""},{"description":{"content":"

Filter by employee id

\n","type":"text/plain"},"key":"employee_id","value":""}],"variable":[]}},"response":[],"_postman_id":"9797a5b2-93d5-4823-a45c-90d0365e240f"},{"name":"Create Order","id":"078f17d5-ff0c-4a19-9321-08822b172364","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{opentoken}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Secret","value":"{{secret}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"order\":{\n \"customer_id\": \"\", // Required, type: string, limite: 36, accept: string, description: Existing Customer id.\n \"service_id\": \"\", // Required, type: string, limite: 36, accept: string, description: Existing Service id.\n \"date\": \"\", // Required, type: string, limite: 10, accept: string, format: 'YYYY-MM-DD', description: Start Date of Order.\n \"time_type\": \"\", // Required, type: string, accept: string, description: Time type of order.\n \"start_time\": \"\", // Required, type: string, limite: 5, accept: string, format: 'HH:MM', description: Start Time of Order.\n \"end_time\": \"\", // Optional, type: string, limite: 5, accept: string, format: 'HH:MM', description: End Time of Order.\n \"total_hours\": \"\", // Required, type: string, limite: 5, accept: string, format: 'HH:MM', description: Total hours of order in case of time type total hours.\n \"flex_time_type\": \"\", // Required, type: string, accept: string, description: Flex time type of order in case of time type flex time.\n \"published\": null, // Optional, type: boolean, accept: boolean, description: \n \"price_type\": \"\", // Required, type: string, accept: string, description: To save price type of the Order.\n \"tax_reduction_type\": \"\", // Optional, type: string, accept: string, description: To save the tax reduction type of the Order.\n \"employee_confirmation_required\": null, // Optional, type: boolean, accept: boolean, description: To store employee confirmation of Order.\n \"sms_on_complete\": null,\n // Optional type: object, accept: object\n \"order_note_attributes\": { \n \"notes\": \"\" // Optional, type: string, accept: string, description: To save any notes for the Order.\n },\n // Optional, type: object, accept: object, description: When adding items to Order.\n \"order_items_attributes\": [ \n {\n \"title\": \"\", // Required, type: string, limite: 255, accept: string, description: item title.\n \"per_unit\": null, // Required, type: float, accept: string/float, description: price of item.\n \"material_cost\": null, // Optional, type: float, accept: string/float, description: total cost of metarial.\n \"housework_type\": \"\", // Optional, type: string, accept: string, description: house work type.\n \"is_housework\": \"\", // Optional, type: boolean, accept: boolead, description: true/false if itme is house work category.\n \"item_id\": \"\", // Optional, type: string, accept: string, description: Existing Item id.\n \"discount\": null, // Optional, type: float, accept: string/float, description: discount\n \"quantity\": null, // Required, type: integer, accept: string/integer, qunatity of item\n \"vat\": null, // Required, type: integer, limite: 100, accept: integer, decription: Item vat.\n \"unit\": \"\", // Required, type: string, limite: 255, accept: string, decription: Item unit.\n \"fortnox_id\": \"\", // Optional, type: string, limite: 255, accept: string, description: item's fortnox id\n \"visma_item_id\": \"\" // Required, type: string, limite: 255, accept: string, description: item's visma id\n }\n ]\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{baseURL}}/orders","description":"\n

Fields that accept particular set of values:

\n
    \n
  1. time_type (Required, Type: String)
    this field only accept specific_time, total_hours, flex_time these values
    Cases:
    1. When time_type is specific_time then start_time is required and total_hours, flex_time_type should not be passed in this case.
    2. When time_type is total_hours then total_hours is required and start_time, flex_time_type should not be passed in this case.
    3. When time_type is flex_time then flex_time_type is required and start_time, total_hours should not be passed in this case.
    2. \n
  2. flex_time_type (Required, Type: String)
    this field only accept flex, morning, afternoon, evening these values
    Case:
    this field is only required when time_type is flex_time
    3. \n
  3. price_type (Required, Type: String)
    this field only accept price_per_item, price_per_employee, fixed these values
    Cases:
    1. When price_type is price_per_item then invoice created is according to price of per item.
    2. When price_type is price_per_employee then invoice created is according to price of per employee working hours count.
    3. When price_type is fixed then invoice created is according to fixed total of items price.
    4. \n
  4. tax_reduction_type (Required, Type: String, Default value: None)
    this field only accept None, Rut, Rot these values which are tax reduction type
    5. \n
  5. Order items > housework_type (Optional, Type: String)
    Cases:
    1. When project's/order's tax_reduction_type is Rut this fields accept \"cleaning\", \"textile_clothing\", \"cooking\", \"snow_plowing\", \"gardening\", \"other_care\", \"tutoring\", \"it_services\", \"other_cost\", \"major_appliance_repair\", \"moving_services\", \"baby_sitting\", \"empty_housework\", \"furnishing\", \"home_maintenance\".
    2. When project's/order's tax_reduction_type is Rot this fields accept \"construction\", \"electricity\", \"glass_metal_work\", \"ground_drainage_work\", \"masonry\", \"painting_wallpapering\", \"hvac\", \"other_cost\".
    6. \n
  6. Order items > unit (Required, Type: String)
    this field only accept tim, km, st, utl, kvm, förp
    7. \n
  7. Order items > vat (Required, Type: Integer)
    this field accept 0, 6, 12, 25
    8. \n
\n

Fields that accept boolean values:

\n
    \n
  1. published (Optional, Type: Boolean, Default value: true)
    2. \n
  2. update_invoice_time (Optional, Type: Boolean, Default value: true)
    3. \n
  3. employee_confimation_required (Optional, Type: Booelan, Default value: true)
    4. \n
  4. sms_on_complete (Optional, Type: Boolean, Default value: false)
    5. \n
  5. Order items > is_housework (Optional, Type: Boolean)
    this field is expected to be true only when projects housework_type is Rut or Rot
    6. \n
\n

Fields that accept values within range or limit:

\n
    \n
  1. Order items > per_unit (Required, Type: Float)
    this field accept float greater than 0 and non negative value
    2. \n
  2. Order items > material_cost (Required, Type: Float)
    this field accept float greater than 0 and non negative value
    3. \n
  3. Order items > discount (Required, Type: Float)
    this field accept float greater than 0 and less than equal to 100 non negative value
    4. \n
  4. Order items > quantity (Required, Type: Float)
    this field accept float greater than 0 and less than equal to 1000 non negative value
    5. \n
\n

Fields that accept particular format

\n
    \n
  1. date (Required, Type: String)
    format \"YYYY-MM-DD\"YYYY = year for ex 2024
    MM = month for ex 01 to 12
    DD = date for ex 01 - 30/31
    2. \n
  2. start_time (Required, Type: String)
    format \"HH:MM\"HH = hours for ex 01:00 to 23:59
    MM = minutes for ex 01 to 59
    3. \n
  3. end_time (Optional, Type: String)
    format \"HH:MM\"
    HH = hours for ex 01:00 to 23:59
    MM = minutes for ex 01 to 59
    4. \n
  4. total_hours (Optional, Type: String)
    format \"YYYY-MM-DD\"YYYY = year for ex 2024
    MM = month for ex 01 to 12
    DD = date for ex 01 - 30/31
    5. \n
\n

Fields that accept valid string

\n
    \n

  1. **customer_id (Required, Type: String)**this field accept valid customer id limit 36 char.

    \n
    2. \n

  2. service_id (Required, Type: String)
    this field accept valid customer id limit 36 char.

    \n
    3. \n

  3. **Order note > notes (Optional, Type: String)**this field accept valid string.

    \n
    4. \n

  4. **Order items > title (Required, Type: String)**this field accept valid string limit 255 char.

    \n
    5. \n

  5. Order items > fortnox_id (Optional, Type: String)
    this fields accept fortnox item id in fortnox_id field in case of company integrated with fortnox.

    \n
    6. \n

  6. Order items > visma_item_id (Required, Type: String)
    this field accept visma item id in visma_item_id field in case of company integrated with visma.

    \n
    7. \n

  7. Order items > item_id (Optional, Type: String)
    this field accept existing item id in item_id field.

    \n
    8. \n
\n","urlObject":{"path":["orders"],"host":["{{baseURL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"078f17d5-ff0c-4a19-9321-08822b172364"},{"name":"Update Order","id":"e36bb74f-8785-4535-befd-9cd3437fb94c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{opentoken}}"}]},"isInherited":false},"method":"PUT","header":[{"key":"Secret","value":"{{secret}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"order\":{\n \"customer_id\": \"\", // Required, type: string, limite: 36, accept: string, description: Existing Customer id.\n \"service_id\": \"\", // Required, type: string, limite: 36, accept: string, description: Existing Service id.\n \"date\": \"\", // Required, type: string, limite: 10, accept: string, format: 'YYYY-MM-DD', description: Start Date of Order.\n \"end_date\": \"\", // Optional, type: string, limite: 10, accept: string, format: 'YYYY-MM-DD', description: End Date of Order.\n \"time_type\": \"\", // Required, type: string, accept: string, description: Time type of order.\n \"start_time\": \"\", // Required, type: string, limite: 5, accept: string, format: 'HH:MM', description: Start Time of Order.\n \"end_time\": \"\", // Optional, type: string, limite: 5, accept: string, format: 'HH:MM', description: End Time of Order.\n \"total_hours\": \"\", // Required, type: string, limite: 5, accept: string, format: 'HH:MM', description: Total hours of Order in case of time type total hours.\n \"flex_time_type\": \"\", // Required, type: string, accept: string, description: Flex time type of order in case of time type flex time.\n \"published\": null, // Optional, type: boolean, accept: boolean, description: \n \"price_type\": \"\", // Required, type: string, accept: string, description: To save price type of the Order.\n \"tax_reduction_type\": \"\", // Optional, type: string, accept: string, description: To save the tax reduction type of the Order.\n \"employee_confirmation_required\": null, // Optional, type: boolean, accept: boolean, description: To store employee confirmation of Order.\n \"sms_on_complete\": null,\n // Optional type: object, accept: object\n \"order_note_attributes\": {\n \"id\": \"\", // Required, type: integer, accept: integer, description: To update the existing record of Order note.\n \"notes\": \"\", // Optional, type: string, accept: string, description: To save any notes for the Order.\n \"_destroy\": \"\" // Optional, type: boolean, accept: boolead, description: To delete the existing record of Order items.\n },\n // Optional, type: object, accept: object, description: When adding items to Order.\n \"order_items_attributes\": [ \n {\n \"id\": null, // Required, type: integer, accept: integer, description: To update the existing record of Order items.\n \"title\": \"\", // Required, type: string, limite: 255, accept: string, description: item title.\n \"per_unit\": null, // Required, type: float, accept: string/float, description: price of item.\n \"material_cost\": null, // Optional, type: float, accept: string/float, description: total cost of metarial.\n \"housework_type\": \"\", // Optional, type: string, accept: string, description: house work type.\n \"is_housework\": \"\", // Optional, type: boolean, accept: boolead, description: true/false if itme is house work category.\n \"item_id\": \"\", // Optional, type: string, accept: string, description: Existing Item id.\n \"discount\": null, // Optional, type: float, accept: string/float, description: discount\n \"quantity\": null, // Required, type: integer, accept: string/integer, qunatity of item\n \"vat\": null, // Required, type: integer, limite: 100, accept: integer, decription: Item vat.\n \"unit\": \"\", // Required, type: string, limite: 255, accept: string, decription: Item unit.\n \"fortnox_id\": \"\", // Optional, type: string, limite: 255, accept: string, description: item's fortnox id\n \"visma_item_id\": \"\", // Required, type: string, limite: 255, accept: string, description: item's visma id.\n \"_destroy\": \"\" // Optional, type: boolean, accept: boolead, description: To delete the existing record of order items.\n }\n ]\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{baseURL}}/orders/:id","description":"\n

Fields that accept particular set of values:

\n
    \n
  1. time_type (Required, Type: String)
    this field only accept specific_time, total_hours, flex_time these values
    Cases:
    1. When time_type is specific_time then start_time is required and total_hours, flex_time_type should not be passed in this case.
    2. When time_type is total_hours then total_hours is required and start_time, flex_time_type should not be passed in this case.
    3. When time_type is flex_time then flex_time_type is required and start_time, total_hours should not be passed in this case.
    2. \n
  2. flex_time_type (Required, Type: String)
    this field only accept flex, morning, afternoon, evening these values
    Case:
    this field is only required when time_type is flex_time
    3. \n
  3. price_type (Required, Type: String)
    this field only accept price_per_item, price_per_employee, fixed these values
    Cases:
    1. When price_type is price_per_item then invoice created is according to price of per item.
    2. When price_type is price_per_employee then invoice created is according to price of per employee working hours count.
    3. When price_type is fixed then invoice created is according to fixed total of items price.
    4. \n
  4. tax_reduction_type (Required, Type: String, Default value: None)
    this field only accept None, Rut, Rot these values which are tax reduction type
    5. \n
  5. Order items > housework_type (Optional, Type: String)
    Cases:
    1. When project's/order's tax_reduction_type is Rut this fields accept \"cleaning\", \"textile_clothing\", \"cooking\", \"snow_plowing\", \"gardening\", \"other_care\", \"tutoring\", \"it_services\", \"other_cost\", \"major_appliance_repair\", \"moving_services\", \"baby_sitting\", \"empty_housework\", \"furnishing\", \"home_maintenance\".
    2. When project's/order's tax_reduction_type is Rot this fields accept \"construction\", \"electricity\", \"glass_metal_work\", \"ground_drainage_work\", \"masonry\", \"painting_wallpapering\", \"hvac\", \"other_cost\".
    6. \n
  6. Order items > unit (Required, Type: String)
    this field only accept tim, km, st, utl, kvm, förp
    7. \n
  7. Order items > vat (Required, Type: Integer)
    this field accept 0, 6, 12, 25
    8. \n
\n

Fields that accept boolean values:

\n
    \n
  1. published (Optional, Type: Boolean, Default value: true)
    2. \n
  2. update_invoice_time (Optional, Type: Boolean, Default value: true)
    3. \n
  3. employee_confimation_required (Optional, Type: Booelan, Default value: true)
    4. \n
  4. sms_on_complete (Optional, Type: Boolean, Default value: false)
    5. \n
  5. Order items > is_housework (Optional, Type: Boolean)
    this field is expected to be true only when projects housework_type is Rut or Rot
    6. \n
\n

Fields that accept values within range or limit:

\n
    \n
  1. Order items > per_unit (Required, Type: Float)
    this field accept float greater than 0 and non negative value
    2. \n
  2. Order items > material_cost (Required, Type: Float)
    this field accept float greater than 0 and non negative value
    3. \n
  3. Order items > discount (Required, Type: Float)
    this field accept float greater than 0 and less than equal to 100 non negative value
    4. \n
  4. Order items > quantity (Required, Type: Float)
    this field accept float greater than 0 and less than equal to 1000 non negative value
    5. \n
\n

Fields that accept particular format

\n
    \n
  1. date (Required, Type: String)
    format \"YYYY-MM-DD\"YYYY = year for ex 2024
    MM = month for ex 01 to 12
    DD = date for ex 01 - 30/31
    2. \n
  2. start_time (Required, Type: String)
    format \"HH:MM\"HH = hours for ex 01:00 to 23:59
    MM = minutes for ex 01 to 59
    3. \n
  3. end_time (Optional, Type: String)
    format \"HH:MM\"
    HH = hours for ex 01:00 to 23:59
    MM = minutes for ex 01 to 59
    4. \n
  4. total_hours (Optional, Type: String)
    format \"YYYY-MM-DD\"YYYY = year for ex 2024
    MM = month for ex 01 to 12
    DD = date for ex 01 - 30/31
    5. \n
\n

Fields that accept valid string

\n
    \n

  1. **customer_id (Required, Type: String)**this field accept valid customer id limit 36 char.

    \n
    2. \n

  2. service_id (Required, Type: String)
    this field accept valid customer id limit 36 char.

    \n
    3. \n

  3. **Order note > notes (Optional, Type: String)**this field accept valid string.

    \n
    4. \n

  4. **Order items > title (Required, Type: String)**this field accept valid string limit 255 char.

    \n
    5. \n

  5. Order items > fortnox_id (Optional, Type: String)
    this fields accept fortnox item id in fortnox_id field in case of company integrated with fortnox.

    \n
    6. \n

  6. Order items > visma_item_id (Required, Type: String)
    this field accept visma item id in visma_item_id field in case of company integrated with visma.

    \n
    7. \n

  7. Order items > item_id (Optional, Type: String)
    this field accept existing item id in item_id field.

    \n
    8. \n
\n","urlObject":{"path":["orders",":id"],"host":["{{baseURL}}"],"query":[],"variable":[{"description":{"content":"

Order 'id' required for deleting particular project details.

\n","type":"text/plain"},"type":"any","value":"Any existing order id","key":"id"}]}},"response":[],"_postman_id":"e36bb74f-8785-4535-befd-9cd3437fb94c"},{"name":"Destroy Order","id":"6166e991-4e6f-49dc-8aa7-95ea9dc516e2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{opentoken}}"}]},"isInherited":false},"method":"DELETE","header":[{"key":"Secret","value":"{{secret}}","type":"text"}],"url":"{{baseURL}}/orders/:id","urlObject":{"path":["orders",":id"],"host":["{{baseURL}}"],"query":[],"variable":[{"description":{"content":"

Order 'id' required for deleting particular order details.

\n","type":"text/plain"},"type":"any","value":"Any existing project id","key":"id"}]}},"response":[],"_postman_id":"6166e991-4e6f-49dc-8aa7-95ea9dc516e2"},{"name":"Create real order from virtual","id":"ffc941a9-c42e-428d-91d0-ea991a74c8fb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{opentoken}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Secret","value":"{{secret}}","type":"text"}],"url":"{{baseURL}}/orders/create_order?project_id=&order_date=","description":"

This request converts the virtual order to real order, virtual orders are the orders without id.
To convert a order that doesn't have id we pass project_id and the date as order_date of that order(virtual order)
project_id is required order_date is required

\n","urlObject":{"path":["orders","create_order"],"host":["{{baseURL}}"],"query":[{"description":{"content":"

Project id of the order that is to be converted to real order

\n","type":"text/plain"},"key":"project_id","value":""},{"description":{"content":"

Order date of that order that is to be converted to real order

\n","type":"text/plain"},"key":"order_date","value":""}],"variable":[]}},"response":[],"_postman_id":"ffc941a9-c42e-428d-91d0-ea991a74c8fb"}],"id":"4e0332d2-7728-4f39-b5d6-8910d27ea745","_postman_id":"4e0332d2-7728-4f39-b5d6-8910d27ea745","description":""},{"name":"Projects","item":[{"name":"Show Project","id":"cb44acaa-2528-4cec-bf2a-b9751ff8b26c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{opentoken}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Secret","value":"{{secret}}","type":"text"}],"url":"{{baseURL}}/projects/:id","urlObject":{"path":["projects",":id"],"host":["{{baseURL}}"],"query":[],"variable":[{"type":"any","value":"Any existing project id","key":"id"}]}},"response":[],"_postman_id":"cb44acaa-2528-4cec-bf2a-b9751ff8b26c"},{"name":"Project list","id":"fab1c595-2ee9-4326-b0ae-aac770244dee","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{opentoken}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Secret","value":"{{secret}}","type":"text"}],"url":"{{baseURL}}/projects?start_date=&end_date=&page=1&per_page=10&project_id=&customer_id=&service_id&employee_id=","description":"

Params:

\n
    \n

  1. start_date (Required, Type: String)

    \n
    2. \n

  2. end_date (Required, Type: String)

    \n
    3. \n

  3. page (Optional, Type: Integer)

    \n
    4. \n

  4. per_page (Optional, Type: Interger, Limit: 100)

    \n
    5. \n

  5. project_id (Optional, Type: Integer) pass project's sequence_num

    \n
    6. \n

  6. customer_id (Optional, Type: String)

    \n
    7. \n

  7. service_id (Optional, Type: String)

    \n
    8. \n

  8. employee_id(Optional, Type: String)

    \n
    9. \n
\n","urlObject":{"path":["projects"],"host":["{{baseURL}}"],"query":[{"description":{"content":"

Filter by start date

\n","type":"text/plain"},"key":"start_date","value":""},{"description":{"content":"

Filter by end date

\n","type":"text/plain"},"key":"end_date","value":""},{"description":{"content":"

Page no of record

\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"

Limit 100 record per page base value 30

\n","type":"text/plain"},"key":"per_page","value":"10"},{"description":{"content":"

Filter by project id

\n","type":"text/plain"},"key":"project_id","value":""},{"description":{"content":"

Filter by customer id

\n","type":"text/plain"},"key":"customer_id","value":""},{"description":{"content":"

Filter by service id

\n","type":"text/plain"},"key":"service_id","value":null},{"description":{"content":"

Filter by employee id

\n","type":"text/plain"},"key":"employee_id","value":""}],"variable":[]}},"response":[],"_postman_id":"fab1c595-2ee9-4326-b0ae-aac770244dee"},{"name":"Create Project","id":"782a5526-ec6b-43fc-8579-e3537a91f374","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{opentoken}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Secret","value":"{{secret}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"project\":{ \n \"customer_id\": \"\", // Required, type: string, limite: 36, accept: string, description: Existing Customer id.\n \"service_id\": \"\", // Required, type: string, limite: 36, accept: string, description: Existing Service id.\n \"start_date\": \"\", // Required, type: string, limite: 10, accept: string, format: 'YYYY-MM-DD', description: Start Date of Project.\n \"end_date\": \"\", // Optional, type: string, limite: 10, accept: string, format: 'YYYY-MM-DD', description: End Date of Project.\n \"time_type\": \"\", // Required, type: string, accept: string, description: Time type of Project.\n \"start_time\": \"\", // Required, type: string, limite: 5, accept: string, format: 'HH:MM', description: Start Time of Project.\n \"end_time\": \"\", // Optional, type: string, limite: 5, accept: string, format: 'HH:MM', description: End Time of Project.\n \"total_hours\": \"\", // Required, type: string, limite: 5, accept: string, format: 'HH:MM', description: Total hours of Project in case of time type total hours.\n \"flex_time_type\": \"\", // Required, type: string, accept: string, description: Flex time type of Project in case of time type flex time.\n \"published\": \"\", // Optional, type: boolean, accept: boolean, description: \n \"price_type\": \"\", // Required, type: string, accept: string, description: To save price type of the project.\n \"tax_reduction_type\": \"\", // Optional, type: string, accept: string, description: To save the tax reduction type of the Project.\n \"employee_confirmation_required\": \"\" ,\n \"sms_on_complete\": \"\", // Optional, type: boolean, accept: boolean, description: To store employee confirmation of Project.\n // Optional type: object, accept: object\n \"project_note_attributes\": { \n \"notes\": \"\" // Optional, type: string, accept: string, description: To save any notes for the Project.\n },\n // // Optional type: object, accept: object\n \"project_recurring_rule_attributes\": { \n \"repeat_type\": \"\", // Required, type: string, accept: string, description: To save repeat type of Project \n \"repeat_days\": [\"\"], // Required, type: array of string, accept: array of string, description: To save days of the week in case of repeat type week.\n \"month_repeat\": \"\", // Required, type: string, accept: string, description: To save type of month repeat day/date in case of repeat type month.\n \"repeat_interval\": null // Required, type: integer, accept: integer, description: To save repeat interval of the Project.\n },\n // // Optional, type: object, accept: object, description: When adding items to project.\n \"project_items_attributes\": [ \n {\n \"title\": \"\", // Required, type: string, limite: 255, accept: string, description: item title.\n \"per_unit\": null, // Required, type: float, accept: string/float, description: price of item.\n \"material_cost\": null, // Optional, type: float, accept: string/float, description: total cost of metarial.\n \"housework_type\": \"\", // Optional, type: string, accept: string, description: house work type.\n \"is_housework\": null, // Optional, type: boolean, accept: boolead, description: true/false if itme is house work category.\n \"item_id\": \"\", // Optional, type: string, accept: string, description: Existing Item id.\n \"discount\": null, // Optional, type: float, accept: string/float, description: discount\n \"quantity\": null, // Required, type: integer, accept: string/integer, description: qunatity of item\n \"vat\": null, // Required, type: integer, limite: 100, accept: integer, description: Item vat.\n \"unit\": \"\", // Required, type: string, limite: 255, accept: string, description: Item unit.\n \"fortnox_id\": \"\", // Required, type: string, limite: 255, accept: string, description: item's fortnox id\n \"visma_item_id\": \"\" // Required, type: string, limite: 255, accept: string, description: item's visma id\n }\n ]\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{baseURL}}/projects","description":"

For Project related fields

\n

Fields that accept particular set of values:

\n
    \n

  1. time_type (Required, Type: String)
    this field only accept specific_time, total_hours, flex_time these values
    Cases:
    1. When time_type is specific_time then start_time is required and total_hours, flex_time_type should not be passed in this case.
    2. When time_type is total_hours then total_hours is required and start_time, flex_time_type should not be passed in this case.
    3. When time_type is flex_time then flex_time_type is required and start_time, total_hours should not be passed in this case.

    \n
    2. \n

  2. flex_time_type (Required, Type: String)
    this field only accept flex, morning, afternoon, evening these values
    Case:
    this field is only required when time_type is flex_time

    \n
    3. \n

  3. price_type (Required, Type: String)
    this field only accept price_per_item, price_per_employee, fixed these values
    Cases:
    1. When price_type is price_per_item then invoice created is according to price of per item.
    2. When price_type is price_per_employee then invoice created is according to price of per employee working hours count.
    3. When price_type is fixed then invoice created is according to fixed total of items price.

    \n
    4. \n

  4. tax_reduction_type (Required, Type: String, Default value: None)
    this field only accept None, Rut, Rot these values which are tax reduction type

    \n
    5. \n

  5. Project recurring rule > repeat_type (Required, Type: String)
    this field only accept week, month these values
    Cases:
    1. When repeat_type is week then repeat_days is required and month_repeat should not be passed in this case.
    2. When repeat_type is month then month_repeat is required and repeat_days should not be passed in this case.

    \n
    6. \n

  6. Project recurring rule > repeat_days (Required, Type: Array of string)
    this field only accept array of week days sunday, monday, tuesday, wednesday, thursday, friday, saturday

    \n
    7. \n

  7. Project recurring rule > month_repeat (Required, Type: String)
    this field only accept day, date these values

    \n
    8. \n

  8. Project items > housework_type (Optional, Type: String)
    Cases:
    1. When project's/order's tax_reduction_type is Rut this fields accept \"cleaning\", \"textile_clothing\", \"cooking\", \"snow_plowing\", \"gardening\", \"other_care\", \"tutoring\", \"it_services\", \"other_cost\", \"major_appliance_repair\", \"moving_services\", \"baby_sitting\", \"empty_housework\", \"furnishing\", \"home_maintenance\".
    2. When project's/order's tax_reduction_type is Rot this fields accept \"construction\", \"electricity\", \"glass_metal_work\", \"ground_drainage_work\", \"masonry\", \"painting_wallpapering\", \"hvac\", \"other_cost\".

    \n
    9. \n

  9. Project items > unit (Required, Type: String)
    this field only accept tim, km, st, utl, kvm, förp

    \n
    10. \n

  10. Project items > vat (Required, Type: Integer)
    this field accept 0, 6, 12, 25

    \n
    11. \n
\n

Fields that accept boolean values:

\n
    \n

  1. published (Optional, Type: Boolean, Default value: true)

    \n
    2. \n

  2. update_invoice_time (Optional, Type: Boolean, Default value: true)

    \n
    3. \n

  3. employee_confimation_required (Optional, Type: Booelan, Default value: true)

    \n
    4. \n

  4. sms_on_complete (Optional, Type: Boolean, Default value: false)

    \n
    5. \n

  5. Project items > is_housework (Optional, Type: Boolean)
    this field is expected to be true only when projects housework_type is Rut or Rot

    \n
    6. \n
\n

Fields that accept values within range or limit:

\n
    \n

  1. Project recurring rule > repeat_interval (Required, Type: Integer)
    this field accept number range from 1 to 12 and non negative value

    \n
    2. \n

  2. Project items > per_unit (Required, Type: Float)
    this field accept float greater than 0 and non negative value

    \n
    3. \n

  3. Project items > material_cost (Required, Type: Float)
    this field accept float greater than 0 and non negative value

    \n
    4. \n

  4. Project items > discount (Required, Type: Float)
    this field accept float greater than 0 and less than equal to 100 non negative value

    \n
    5. \n

  5. Project items > quantity (Required, Type: Float)
    this field accept float greater than 0 and less than equal to 1000 non negative value

    \n
    6. \n
\n

Fields that accept particular format

\n
    \n

  1. start_date (Required, Type: String)
    format \"YYYY-MM-DD\"YYYY = year for ex 2024
    MM = month for ex 01 to 12
    DD = date for ex 01 - 30/31

    \n
    2. \n

  2. end_date (Optional, Type: String)
    format \"YYYY-MM-DD\"
    YYYY = year for ex 2024
    MM = month for ex 01 to 12
    DD = date for ex 01 - 30/31

    \n
    3. \n

  3. start_time (Required, Type: String)
    format \"HH:MM\"HH = hours for ex 01:00 to 23:59
    MM = minutes for ex 01 to 59

    \n
    4. \n

  4. end_time (Optional, Type: String)
    format \"HH:MM\"
    HH = hours for ex 01:00 to 23:59
    MM = minutes for ex 01 to 59

    \n
    5. \n
\n

Fields that accept valid string

\n
    \n

  1. **customer_id (Required, Type: String)**this field accept valid customer id limit 36 char.

    \n
    2. \n

  2. service_id (Required, Type: String)
    this field accept valid customer id limit 36 char.

    \n
    3. \n

  3. **Project note > notes (Optional, Type: String)**this field accept valid string.

    \n
    4. \n

  4. **Project items > title (Required, Type: String)**this field accept valid string limit 255 char.

    \n
    5. \n

  5. Project items > fortnox_id (Optional, Type: String)
    this fields accept fortnox item id in fortnox_id field in case of company integrated with fortnox.

    \n
    6. \n

  6. Project items > visma_item_id (Required, Type: String)
    this field accept visma item id in visma_item_id field in case of company integrated with visma.

    \n
    7. \n

  7. Order items > item_id (Optional, Type: String)
    this field accept existing item id in item_id field.

    \n
    8. \n
\n","urlObject":{"path":["projects"],"host":["{{baseURL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"782a5526-ec6b-43fc-8579-e3537a91f374"},{"name":"Update Project","id":"14cd0bb3-2e2f-4e18-92b7-754c8c8e5665","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{opentoken}}"}]},"isInherited":false},"method":"PUT","header":[{"key":"Secret","value":"{{secret}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"project\":{\n \"customer_id\": \"\", // Required, type: string, limite: 36, accept: string, description: Existing Customer id.\n \"service_id\": \"\", // Required, type: string, limite: 36, accept: string, description: Existing Service id.\n \"start_date\": \"\", // Required, type: string, limite: 10, accept: string, format: 'YYYY-MM-DD', description: Start Date of Project.\n \"end_date\": \"\", // Optional, type: string, limite: 10, accept: string, format: 'YYYY-MM-DD', description: End Date of Project.\n \"time_type\": \"\", // Required, type: string, accept: string, description: Time type of Project.\n \"start_time\": \"\", // Required, type: string, limite: 5, accept: string, format: 'HH:MM', description: Start Time of Project.\n \"end_time\": \"\", // Optional, type: string, limite: 5, accept: string, format: 'HH:MM', description: End Time of Project.\n \"total_hours\": \"\", // Required, type: string, limite: 5, accept: string, format: 'HH:MM', description: Total hours of Project in case of time type total hours.\n \"flex_time_type\": \"\", // Required, type: string, accept: string, description: Flex time type of Project in case of time type flex time.\n \"published\": \"\", // Optional, type: boolean, accept: boolean, description: \n \"price_type\": \"\", // Required, type: string, accept: string, description: To save price type of the project.\n \"tax_reduction_type\": \"\", // Optional, type: string, accept: string, description: To save the tax reduction type of the Project.\n \"employee_confirmation_required\": \"\", // Optional, type: boolean, accept: boolean, description: To store employee confirmation of Project.\n // Optional type: object, accept: object\n \"project_note_attributes\": {\n \"id\": \"\", // Required, type: integer, accept: integer, description: To update the existing record of Project note.\n \"notes\": \"\", // Optional, type: string, accept: string, description: To save any notes for the Project.\n \"_destroy\": \"\" // Optional, type: boolean, accept: boolead, description: To delete the existing record of Project items.\n },\n // Optional, type: object, accept: object, description: When adding items to project.\n \"project_items_attributes\": [ \n {\n \"id\": \"\", // Required, type: integer, accept: integer, description: To update the existing record of Project items.\n \"title\": \"\", // Required, type: string, limite: 255, accept: string, description: item title.\n \"per_unit\": \"\", // Required, type: float, accept: string/float, description: price of item.\n \"material_cost\": \"\", // Optional, type: float, accept: string/float, description: total cost of metarial.\n \"housework_type\": \"\", // Optional, type: string, accept: string, description: house work type.\n \"is_housework\": \"\", // Optional, type: boolean, accept: boolead, description: true/false if itme is house work category.\n \"item_id\": \"\", // Optional, type: string, accept: string, description: Existing Item id.\n \"discount\": \"\", // Optional, type: float, accept: string/float, description: discount\n \"quantity\": 3, // Required, type: integer, accept: string/integer, qunatity of item\n \"vat\": 12, // Required, type: integer, limite: 100, accept: integer, decription: Item vat.\n \"unit\": \"\", // Required, type: string, limite: 255, accept: string, decription: Item unit.\n \"fortnox_id\": \"\", // Optional, type: string, limite: 255, accept: string, description: item's fortnox id\n \"visma_item_id\": \"\", // Required, type: string, limite: 255, accept: string, description: item's visma id.\n \"_destroy\": \"\" // Optional, type: boolean, accept: boolead, description: To delete the existing record of Project items.\n }\n ]\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{baseURL}}/projects/:id","description":"\n

Fields that accept particular set of values:

\n
    \n

  1. time_type (Required, Type: String)
    this field only accept specific_time, total_hours, flex_time these values
    Cases:
    1. When time_type is specific_time then start_time is required and total_hours, flex_time_type should not be passed in this case.
    2. When time_type is total_hours then total_hours is required and start_time, flex_time_type should not be passed in this case.
    3. When time_type is flex_time then flex_time_type is required and start_time, total_hours should not be passed in this case.

    \n
    2. \n

  2. flex_time_type (Required, Type: String)
    this field only accept flex, morning, afternoon, evening these values
    Case:
    this field is only required when time_type is flex_time

    \n
    3. \n

  3. price_type (Required, Type: String)
    this field only accept price_per_item, price_per_employee, fixed these values
    Cases:
    1. When price_type is price_per_item then invoice created is according to price of per item.
    2. When price_type is price_per_employee then invoice created is according to price of per employee working hours count.
    3. When price_type is fixed then invoice created is according to fixed total of items price.

    \n
    4. \n

  4. tax_reduction_type (Required, Type: String, Default value: None)
    this field only accept None, Rut, Rot these values which are tax reduction type

    \n
    5. \n

  5. Project items > housework_type (Optional, Type: String)
    Cases:
    1. When project's/order's tax_reduction_type is Rut this fields accept \"cleaning\", \"textile_clothing\", \"cooking\", \"snow_plowing\", \"gardening\", \"other_care\", \"tutoring\", \"it_services\", \"other_cost\", \"major_appliance_repair\", \"moving_services\", \"baby_sitting\", \"empty_housework\", \"furnishing\", \"home_maintenance\".
    2. When project's/order's tax_reduction_type is Rot this fields accept \"construction\", \"electricity\", \"glass_metal_work\", \"ground_drainage_work\", \"masonry\", \"painting_wallpapering\", \"hvac\", \"other_cost\".

    \n
    6. \n

  6. Project items > unit (Required, Type: String)
    this field only accept tim, km, st, utl, kvm, förp

    \n
    7. \n

  7. Project items > vat (Required, Type: Integer)
    this field accept 0, 6, 12, 25

    \n
    8. \n
\n

Fields that accept boolean values:

\n
    \n

  1. published (Optional, Type: Boolean, Default value: true)

    \n
    2. \n

  2. update_invoice_time (Optional, Type: Boolean, Default value: true)

    \n
    3. \n

  3. employee_confimation_required (Optional, Type: Booelan, Default value: true)

    \n
    4. \n

  4. sms_on_complete (Optional, Type: Boolean, Default value: false)

    \n
    5. \n

  5. Project items > is_housework (Optional, Type: Boolean)
    this field is expected to be true only when projects housework_type is Rut or Rot

    \n
    6. \n
\n

Fields that accept values within range or limit:

\n
    \n

  1. Project items > per_unit (Required, Type: Float)
    this field accept float greater than 0 and non negative value

    \n
    2. \n

  2. Project items > material_cost (Required, Type: Float)
    this field accept float greater than 0 and non negative value

    \n
    3. \n

  3. Project items > discount (Required, Type: Float)
    this field accept float greater than 0 and less than equal to 100 non negative value

    \n
    4. \n

  4. Project items > quantity (Required, Type: Float)
    this field accept float greater than 0 and less than equal to 1000 non negative value

    \n
    5. \n
\n

Fields that accept particular format

\n
    \n

  1. start_date (Required, Type: String)
    format \"YYYY-MM-DD\"YYYY = year for ex 2024
    MM = month for ex 01 to 12
    DD = date for ex 01 - 30/31

    \n
    2. \n

  2. end_date (Optional, Type: String)
    format \"YYYY-MM-DD\"
    YYYY = year for ex 2024
    MM = month for ex 01 to 12
    DD = date for ex 01 - 30/31

    \n
    3. \n

  3. start_time (Required, Type: String)
    format \"HH:MM\"HH = hours for ex 01:00 to 23:59
    MM = minutes for ex 01 to 59

    \n
    4. \n

  4. end_time (Optional, Type: String)
    format \"HH:MM\"
    HH = hours for ex 01:00 to 23:59
    MM = minutes for ex 01 to 59

    \n
    5. \n
\n

Fields that accept valid string

\n
    \n

  1. **customer_id (Required, Type: String)**this field accept valid customer id limit 36 char.

    \n
    2. \n

  2. service_id (Required, Type: String)
    this field accept valid customer id limit 36 char.

    \n
    3. \n

  3. **Project note > notes (Optional, Type: String)**this field accept valid string.

    \n
    4. \n

  4. **Project items > title (Required, Type: String)**this field accept valid string limit 255 char.

    \n
    5. \n

  5. Project items > fortnox_id (Optional, Type: String)
    this fields accept fortnox item id in fortnox_id field in case of company integrated with fortnox.

    \n
    6. \n

  6. Project items > visma_item_id (Required, Type: String)
    this field accept visma item id in visma_item_id field in case of company integrated with visma.

    \n
    7. \n

  7. Order items > item_id (Optional, Type: String)
    this field accept existing item id in item_id field.

    \n
    8. \n
\n","urlObject":{"path":["projects",":id"],"host":["{{baseURL}}"],"query":[],"variable":[{"description":{"content":"

Project 'id' required for deleting particular project details.

\n","type":"text/plain"},"type":"any","value":"Any existing project id","key":"id"}]}},"response":[],"_postman_id":"14cd0bb3-2e2f-4e18-92b7-754c8c8e5665"},{"name":"Destroy Project","id":"4e77dd79-ec5e-4eb4-abdb-08fb19c3d0e4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{opentoken}}"}]},"isInherited":false},"method":"DELETE","header":[{"key":"Secret","value":"{{secret}}","type":"text"}],"url":"{{baseURL}}/projects/:id","urlObject":{"path":["projects",":id"],"host":["{{baseURL}}"],"query":[],"variable":[{"description":{"content":"

Project 'id' required for deleting particular project details.

\n","type":"text/plain"},"type":"any","value":"Any existing project id","key":"id"}]}},"response":[],"_postman_id":"4e77dd79-ec5e-4eb4-abdb-08fb19c3d0e4"}],"id":"1ca54b2b-3c87-4b92-b98d-feda4bd96aab","_postman_id":"1ca54b2b-3c87-4b92-b98d-feda4bd96aab","description":""},{"name":"Projects Recurring Rule","item":[{"name":"Add Recurring Rule","id":"1aaff0be-97aa-4853-b096-c0fe858753ef","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{opentoken}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Secret","value":"{{secret}}","type":"text"}],"body":{"mode":"raw","raw":"{ \n \"recurring_rule\": {\n \"repeat_type\": \"week\", // Required, type: string, accept: string, description: To save repeat type of Project\n \"repeat_days\": [\"\"], // Required, type: array of string, accept: array of string, description: To save days of the week in case of repeat type week.\n \"repeat_interval\": null, // Required, type: integer, accept: integer, description: To save repeat interval of the Project.\n \"month_repeat\": \"\" // Required, type: string, accept: string, description: To save type of month repeat day/date in case of repeat type month.\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{baseURL}}/projects/:id/add_recurring_rule","description":"

For Project related fields

\n

Fields that accept particular set of values:

\n
    \n

  1. repeat_type (Required, Type: String)
    this field only accept week, month these values
    Cases:
    1. When repeat_type is week then repeat_days is required and month_repeat should not be passed in this case.
    2. When repeat_type is month then month_repeat is required and repeat_days should not be passed in this case.

    \n
    2. \n

  2. repeat_days (Required, Type: Array of string)
    this field only accept array of week days sunday, monday, tuesday, wednesday, thursday, friday, saturday

    \n
    3. \n

  3. month_repeat (Required, Type: String)
    this field only accept day, date these values

    \n
    4. \n
\n

Fields that accept values within range or limit:

\n
    \n
  1. repeat_interval (Required, Type: Integer)
    this field accept number range from 1 to 12 and non negative value
    2. \n
\n","urlObject":{"path":["projects",":id","add_recurring_rule"],"host":["{{baseURL}}"],"query":[],"variable":[{"description":{"content":"

Project 'id' required for adding recurring rule to any project.

\n","type":"text/plain"},"type":"any","value":"Any existing project id","key":"id"}]}},"response":[],"_postman_id":"1aaff0be-97aa-4853-b096-c0fe858753ef"},{"name":"Update Recurring Rule","id":"5485e0d9-5201-4484-bf3e-2055862f99dc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{opentoken}}"}]},"isInherited":false},"method":"PUT","header":[{"key":"Secret","value":"{{secret}}","type":"text"}],"body":{"mode":"raw","raw":"{ \n \"recurring_rule\": {\n \"id\": \"\", // Required, type: integer, accept: integer, description: To update the existing record of Project recurring rule.\n \"repeat_days\": [\"\"], // Required, type: array of string, accept: array of string, description: To save days of the week in case of repeat type week.\n \"repeat_interval\": null, // Required, type: integer, accept: integer, description: To save repeat interval of the Project.\n \"month_repeat\": \"\" // Required, type: string, accept: string, description: To save type of month repeat day/date in case of repeat type month.\n },\n \"remove_past_order\": true // Optional, type: boolean, accept: boolean, description: To remove all past active orders associated with the project before applying the updated recurring rule date.\n}","options":{"raw":{"language":"json"}}},"url":"{{baseURL}}/projects/:id/update_recurring_rule","description":"\n

Fields that accept particular set of values:

\n
    \n

  1. repeat_days (Required, Type: Array of string)
    this field only accept array of week days sunday, monday, tuesday, wednesday, thursday, friday, saturday

    \n
    2. \n

  2. month_repeat (Required, Type: String)
    this field only accept day, date these values

    \n
    3. \n
\n

Fields that accept values within range or limit:

\n
    \n
  1. repeat_interval (Required, Type: Integer)
    this field accept number range from 1 to 12 and non negative value
    2. \n
\n

Fields that accept boolean values:

\n
    \n
  1. remove_past_order (Optional, Type: Boolean)
    2. \n
\n","urlObject":{"path":["projects",":id","update_recurring_rule"],"host":["{{baseURL}}"],"query":[],"variable":[{"description":{"content":"

Project 'id' required for updating recurring rule to any project.

\n","type":"text/plain"},"type":"any","value":"Any existing project id","key":"id"}]}},"response":[],"_postman_id":"5485e0d9-5201-4484-bf3e-2055862f99dc"},{"name":"Destroy Recurring Rule","id":"5f13477e-b4e8-4be9-b715-1d00e1fa48da","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{opentoken}}"}]},"isInherited":false},"method":"DELETE","header":[{"key":"Secret","value":"{{secret}}","type":"text"}],"url":"{{baseURL}}/projects/:id/delete_recurring_rule","urlObject":{"path":["projects",":id","delete_recurring_rule"],"host":["{{baseURL}}"],"query":[],"variable":[{"description":{"content":"

Project 'id' required for removing recurring rule to any project.

\n","type":"text/plain"},"type":"any","value":"Any existing project id","key":"id"}]}},"response":[],"_postman_id":"5f13477e-b4e8-4be9-b715-1d00e1fa48da"}],"id":"80e10996-6402-43dd-8c4c-a85695b5b5fa","_postman_id":"80e10996-6402-43dd-8c4c-a85695b5b5fa","description":""},{"name":"Booking & Schema Online - API V2","item":[{"name":"Services","item":[{"name":"Create Services","id":"7307d41b-b5ee-40a8-9dc0-21edcb3fe194","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{opentoken}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Secret","value":"{{secret}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"title\": \"\", // Required, type: string, limite: 255, accept: string, decription: Title of the service to be created.\n \"description\": \"\", // Required, type: string, limite: 255, accept: string, decription: Description of the service to be created.\n \"is_active\": true // Optional, type: boolean, accept: boolean, decription: To set created service activated.\n}","options":{"raw":{"language":"json"}}},"url":"{{baseURL}}/services","urlObject":{"path":["services"],"host":["{{baseURL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"7307d41b-b5ee-40a8-9dc0-21edcb3fe194"},{"name":"Update Services","id":"c185c432-9a6a-4bbb-a83d-0c2093016011","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"PUT","header":[{"key":"Secret","value":"{{secret}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"title\": \"\", // Required, type: string, limite: 255, accept: string, decription: Title of the service to be updated.\n \"description\": \"\", // Optional, type: string, limite: 255, accept: string, decription: Description of the service to be updated.\n \"is_active\": true // Optional, type: boolean, accept: boolean, decription: To set created service updated.\n}","options":{"raw":{"language":"json"}}},"url":"{{baseURL}}/services/:sequence_num","urlObject":{"path":["services",":sequence_num"],"host":["{{baseURL}}"],"query":[],"variable":[{"description":{"content":"

Service 'sequence_num' required for updating particular service details.

\n","type":"text/plain"},"type":"any","value":"Any existing service sequence_num","key":"sequence_num"}]}},"response":[],"_postman_id":"c185c432-9a6a-4bbb-a83d-0c2093016011"},{"name":"Delete Services","id":"a1bce724-5960-41e6-a8b8-9569810f9eef","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"DELETE","header":[{"key":"Secret","value":"{{secret}}","type":"text"}],"url":"{{baseURL}}/services/:sequence_num","urlObject":{"path":["services",":sequence_num"],"host":["{{baseURL}}"],"query":[],"variable":[{"description":{"content":"

Service 'sequence_num' required for deleting particular service details.

\n","type":"text/plain"},"type":"any","value":"Any existing service sequence_num","key":"sequence_num"}]}},"response":[],"_postman_id":"a1bce724-5960-41e6-a8b8-9569810f9eef"},{"name":"Service list","id":"451ac8d5-e86c-436f-87a1-ca943338ab0b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Secret","value":"{{secret}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{baseURL}}/services?page=1&per_page=10&title=","urlObject":{"path":["services"],"host":["{{baseURL}}"],"query":[{"description":{"content":"

Page no of record

\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"

Limit 100 record per page base value 30

\n","type":"text/plain"},"key":"per_page","value":"10"},{"description":{"content":"

Filter by service title

\n","type":"text/plain"},"key":"title","value":""}],"variable":[]}},"response":[],"_postman_id":"451ac8d5-e86c-436f-87a1-ca943338ab0b"},{"name":"Show Service","id":"cc14c87d-85f2-4123-b2c2-3e6369b8b467","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Secret","value":"{{secret}}","type":"text"}],"url":"{{baseURL}}/services/:sequence_num","urlObject":{"path":["services",":sequence_num"],"host":["{{baseURL}}"],"query":[],"variable":[{"description":{"content":"

Service 'sequence_num' required for getting particular service details

\n","type":"text/plain"},"type":"any","value":"Any existing service sequence_num","key":"sequence_num"}]}},"response":[],"_postman_id":"cc14c87d-85f2-4123-b2c2-3e6369b8b467"}],"id":"1d7afb17-a9c1-4093-ae42-e29cb2ede5e0","_postman_id":"1d7afb17-a9c1-4093-ae42-e29cb2ede5e0","description":""},{"name":"Customers","item":[{"name":"Show Customer","id":"6755d892-206c-4f48-b3a9-49a1acb7d3f9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Secret","value":"{{secret}}","type":"text"}],"url":"{{baseURL}}/customers/:sequence_num","urlObject":{"path":["customers",":sequence_num"],"host":["{{baseURL}}"],"query":[],"variable":[{"description":{"content":"

Customer 'sequence_num' required for getting particular customer details.

\n","type":"text/plain"},"type":"any","value":"Any existing customer sequence_num","key":"sequence_num"}]}},"response":[],"_postman_id":"6755d892-206c-4f48-b3a9-49a1acb7d3f9"},{"name":"Create Customer","id":"aeb2cd94-74ec-44ec-8555-3f3b0bfa0406","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Secret","value":"{{secret}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"customer\": {\n \"name\": \"\", // Required, type: string, limite: 255, accept: string, decription: Customer name.\n \"contact_name\": \"\", // Optional, type: string, limite: 255, accept: string, decription: Customer contact name.\n \"customer_number\": \"\", // Optional, type: string, limite: 255, accept: string, decription: Customer customer number.\n \"email\": \"\", // Optional, type: string, limite: 255, accept: string, decription: Customer email.\n \"invoice_email\": \"\", // Optional, type: string, limite: 255, accept: string, decription: Customer invoice email.\n \"mobile\": \"\", // Optional, type: string, limite: 255, accept: string, decription: Customer mobile.\n \"telephone\": \"\", // Optional, type: string, limite: 255, accept: string, decription: Customer telephone.\n \"address\": \"\" , // Optional, type: string, limite: 255, accept: string, decription: Customer address.\n \"door_code\": \"\", // Optional, type: string, limite: 255, accept: string, decription: Customer door code.\n \"is_organisation\": \"\", // Optional, type: boolean, accept: boolean, decription: Customer is organisation or individual.\n \"vat_included\": \"\" // Optional, type: boolean, accept: boolean, decription: Customer's vat included.\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{baseURL}}/customers","urlObject":{"path":["customers"],"host":["{{baseURL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"aeb2cd94-74ec-44ec-8555-3f3b0bfa0406"},{"name":"Update Customer","id":"18ce4b2b-e529-4f31-a83d-acf271490c88","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{opentoken}}"}]},"isInherited":false},"method":"PUT","header":[{"key":"Secret","value":"{{secret}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"customer\": {\n \"name\": \"\", // Required, type: string, limit: 255, accept: string, decription: Customer name.\n \"contact_name\": \"\", // Optional, type: string, limit: 255, accept: string, decription: Customer contact name.\n \"customer_number\": \"\", // Optional, type: string, limit: 255, accept: string, decription: Customer customer number.\n \"email\": \"\", // Optional, type: string, limit: 255, accept: string, decription: Customer email.\n \"invoice_email\": \"\", // Optional, type: string, limite: 255, accept: string, decription: Customer invoice email.\n \"mobile\": \"\", // Optional, type: string, limit: 255, accept: string, decription: Customer mobile.\n \"telephone\": \"\", // Optional, type: string, limit: 255, accept: string, decription: Customer telephone.\n \"address\": \"\", // Optional, type: string, limit: 255, accept: string, decription: Customer address.\n \"zip_code\": \"\", // Optional, type: string, limit: 255, accept: string, decription: Customer address.\n \"area\": \"\", // Optional, type: string, limit: 255, accept: string, decription: Customer address.\n \"vat_number\": \"\", // Optional, type: string, limit: 255, accept: string, decription: Customer address.\n \"door_code\": \"\", // Optional, type: string, limit: 255, accept: string, decription: Customer door code.\n \"is_organisation\": \"\", // Optional, type: boolean, accept: boolean, decription: Customer is organisation or individual.\n \"vat_included\": \"\" // Optional, type: boolean, accept: boolean, decription: Customer's vat included.\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{baseURL}}/customers/:sequence_num","urlObject":{"path":["customers",":sequence_num"],"host":["{{baseURL}}"],"query":[],"variable":[{"description":{"content":"

Customer 'sequence_num' required for updating particular customer details.

\n","type":"text/plain"},"type":"any","value":"Any existing customer sequence_num","key":"sequence_num"}]}},"response":[],"_postman_id":"18ce4b2b-e529-4f31-a83d-acf271490c88"},{"name":"Delete Customer","id":"fc5e2063-3e02-4c7c-a745-ca9ec342be9b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"DELETE","header":[{"key":"Secret","value":"{{secret}}","type":"text"}],"url":"{{baseURL}}/customers/:sequence_num","urlObject":{"path":["customers",":sequence_num"],"host":["{{baseURL}}"],"query":[],"variable":[{"description":{"content":"

Customer 'sequence_num' required for deleting particular customer details.

\n","type":"text/plain"},"type":"any","value":"Any existing customer sequence_num","key":"sequence_num"}]}},"response":[],"_postman_id":"fc5e2063-3e02-4c7c-a745-ca9ec342be9b"},{"name":"Custome List","id":"9e8fc050-2e3e-43f0-b6df-2a511da72e55","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Secret","value":"{{secret}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{baseURL}}/customers?page=1&per_page=10&name=&customer_number=","urlObject":{"path":["customers"],"host":["{{baseURL}}"],"query":[{"description":{"content":"

Page no of record

\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"

Limit 100 record per page base value 30

\n","type":"text/plain"},"key":"per_page","value":"10"},{"description":{"content":"

Filter by customer's name

\n","type":"text/plain"},"key":"name","value":""},{"description":{"content":"

Filter by customer's number

\n","type":"text/plain"},"key":"customer_number","value":""}],"variable":[]}},"response":[],"_postman_id":"9e8fc050-2e3e-43f0-b6df-2a511da72e55"}],"id":"20c06bb2-f1b6-4b02-ad6a-47ec02c2ade3","_postman_id":"20c06bb2-f1b6-4b02-ad6a-47ec02c2ade3","description":""},{"name":"Employees","item":[{"name":"Employee list","id":"af8b09aa-56c6-4bae-8e4c-27b94753ec59","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Secret","value":"{{secret}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{baseURL}}/employees?page=1&per_page=10&name=","urlObject":{"path":["employees"],"host":["{{baseURL}}"],"query":[{"description":{"content":"

Page no of record

\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"

Limit 100 record per page base value 30

\n","type":"text/plain"},"key":"per_page","value":"10"},{"description":{"content":"

Filter by employee name

\n","type":"text/plain"},"key":"name","value":""}],"variable":[]}},"response":[],"_postman_id":"af8b09aa-56c6-4bae-8e4c-27b94753ec59"},{"name":"Show Employee","id":"70ab39e7-96d3-4c19-91a6-f454c8c4cbb9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Secret","value":"{{secret}}","type":"text"}],"url":"{{baseURL}}/employees/:sequence_num","urlObject":{"path":["employees",":sequence_num"],"host":["{{baseURL}}"],"query":[],"variable":[{"description":{"content":"

Employee 'sequence_num' required for getting particular employee details.

\n","type":"text/plain"},"type":"any","value":"Any existing employee sequence_num","key":"sequence_num"}]}},"response":[],"_postman_id":"70ab39e7-96d3-4c19-91a6-f454c8c4cbb9"},{"name":"Create Employee","id":"45e47626-9e35-48f4-b205-0648e4d88dc1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Secret","value":"{{secret}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"employee\": {\n \"name\": \"\", // Required, type: string, limite: 255, accept: string, decription: Employee name.\n \"identification_num\": \"\", // Optional, type: string, limite: 255, accept: string, decription: Employee identification num.\n \"email\": \"\", // Required, type: string, limite: 255, accept: string, decription: Employee login email. \n \"employee_number\": \"\", // Optional, type: string, limite: 255, accept: string, decription: Employee employee number.\n \"mobile\": \"\", // Optional, type: string, limite: 255, accept: string, decription: Employee mobile.\n \"phone\": \"\", // Optional, type: string, limite: 255, accept: string, decription: Employee phone.\n \"address\": \"\", // Optional, type: string, limite: 255, accept: string, decription: Employee address.\n \"area\": \"\", // Optional, type: string, limite: 255, accept: string, decription: Employee area.\n \"zip_code\": \"\", // Optional, type: string, limite: 255, accept: string, decription: Employee zip code.\n \"salary_type\": \"\", // Required, type: string, limit: 255, allowed values: 'TID' or 'ARB', description: Salary type.\n \"send_employee_login_details\": \"\" // Optional, type: boolean, allowed values: true or false, description: Whether to send login details to the employee.\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{baseURL}}/employees","urlObject":{"path":["employees"],"host":["{{baseURL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"45e47626-9e35-48f4-b205-0648e4d88dc1"},{"name":"Update Employee","id":"df354fd6-888b-4282-a4d9-b853b409e8b5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"PUT","header":[{"key":"Secret","value":"{{secret}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"employee\": {\n \"name\": \"\", // Required, type: string, limite: 255, accept: string, decription: Employee name.\n \"identification_num\": \"\", // Optional, type: string, limite: 255, accept: string, decription: Employee identification num.\n \"employee_number\": \"\", // Optional, type: string, limite: 255, accept: string, decription: Employee employee number.\n \"mobile\": \"\", // Optional, type: string, limite: 255, accept: string, decription: Employee mobile.\n \"phone\": \"\", // Optional, type: string, limite: 255, accept: string, decription: Employee phone.\n \"address\": \"\", // Optional, type: string, limite: 255, accept: string, decription: Employee address.\n \"area\": \"\", // Optional, type: string, limite: 255, accept: string, decription: Employee area.\n \"zip_code\": \"\", // Optional, type: string, limite: 255, accept: string, decription: Employee zip code.\n \"salary_type\": \"\" // Required, type: string, limit: 255, allowed values: 'TID' or 'ARB', description: Salary type.\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{baseURL}}/employees/:sequence_num","urlObject":{"path":["employees",":sequence_num"],"host":["{{baseURL}}"],"query":[],"variable":[{"description":{"content":"

Employee 'sequence_num' required for updating particular employee details.

\n","type":"text/plain"},"type":"any","value":"Any existing employee sequence_num","key":"sequence_num"}]}},"response":[],"_postman_id":"df354fd6-888b-4282-a4d9-b853b409e8b5"},{"name":"Delete Employee","id":"5170383c-d382-4049-85db-36dc75a036b0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"DELETE","header":[{"key":"Secret","value":"{{secret}}","type":"text"}],"url":"{{baseURL}}/employees/:sequence_num","urlObject":{"path":["employees",":sequence_num"],"host":["{{baseURL}}"],"query":[],"variable":[{"description":{"content":"

Employee 'sequence_num' required for deleting particular employee details.

\n","type":"text/plain"},"type":"any","value":"Any existing employee sequence_num","key":"sequence_num"}]}},"response":[],"_postman_id":"5170383c-d382-4049-85db-36dc75a036b0"},{"name":"Update Employee Login Email","id":"686d8600-1abc-4e8a-9208-daa343276190","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Secret","value":"{{secret}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"employee\": {\r\n \"email\": \"\" // Required, type: string, limite: 255, accept: string, decription: Employee login email.\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"{{baseURL}}/employees/:sequence_num/update_login_email","urlObject":{"path":["employees",":sequence_num","update_login_email"],"host":["{{baseURL}}"],"query":[],"variable":[{"description":{"content":"

Employee 'sequence_num' required for getting particular employee details.

\n","type":"text/plain"},"type":"any","value":"Any existing employee sequence_num","key":"sequence_num"}]}},"response":[],"_postman_id":"686d8600-1abc-4e8a-9208-daa343276190"}],"id":"9b2fbc3f-dc26-4ce2-8295-6adce8a7911c","_postman_id":"9b2fbc3f-dc26-4ce2-8295-6adce8a7911c","description":""},{"name":"Items","item":[{"name":"Show Item","id":"b4c7cb0d-7dde-4646-a261-b6d4ad0f9f27","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Secret","value":"{{secret}}","type":"text"}],"url":"{{baseURL}}/items/:sequence_num","urlObject":{"path":["items",":sequence_num"],"host":["{{baseURL}}"],"query":[],"variable":[{"description":{"content":"

Item 'sequence_num' required for getting particular item details.

\n","type":"text/plain"},"type":"any","value":"Any existing item sequence_num","key":"sequence_num"}]}},"response":[],"_postman_id":"b4c7cb0d-7dde-4646-a261-b6d4ad0f9f27"},{"name":"Item List","id":"0a58132e-2e05-4de6-b31d-bd7ce61a166c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{opentoken}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Secret","value":"{{secret}}","type":"text"}],"url":"{{baseURL}}/items?page=1&per_page=&title=&visma_items=true","urlObject":{"path":["items"],"host":["{{baseURL}}"],"query":[{"description":{"content":"

Page no of record

\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"

Limit 100 record per page base value 30

\n","type":"text/plain"},"key":"per_page","value":""},{"description":{"content":"

Filter by item's title

\n","type":"text/plain"},"key":"title","value":""},{"description":{"content":"

Filter to get only visma items

\n","type":"text/plain"},"key":"visma_items","value":"true"}],"variable":[]}},"response":[],"_postman_id":"0a58132e-2e05-4de6-b31d-bd7ce61a166c"},{"name":"Create Item","id":"1dfa8fbd-af16-4667-bf1c-2175db356b56","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Secret","value":"{{secret}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"item\": {\n \"title\": \"\", // Required, type: string, limite: 255, accept: string, decription: Item title.\n \"unit\": \"\", // Required, type: string, limite: 255, accept: string, decription: Item unit.\n \"vat\": \"\", // Required, type: integer, limite: 100, accept: integer, decription: Item vat.\n \"excl_vat_per_unit\": \"\", // Required, type: float, accept: float, description: Price per unit excluding VAT.\n \"incl_vat_per_unit\": \"\" // Required, type: float, accept: float, description: Price per unit including VAT.\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{baseURL}}/items","description":"

For 'unit' attribute allowed values are:
'tim', 'km', 'st', 'utl', 'kvm', 'förp'

\n

For 'vat' attribute allowed values are:

\n

0, 6, 12, 25

\n","urlObject":{"path":["items"],"host":["{{baseURL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"1dfa8fbd-af16-4667-bf1c-2175db356b56"},{"name":"Update Item","id":"b6dbef5e-c3df-42bc-b318-b24c1dd66f7e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"PUT","header":[{"key":"Secret","value":"{{secret}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"item\": {\n \"title\": \"\", // Required, type: string, limite: 255, accept: string, decription: Item title.\n \"unit\": \"\", // Optional, type: string, limite: 255, accept: string, decription: Item unit.\n \"vat\": \"\", // Required, type: integer, limite: 100, accept: integer, decription: Item vat.\n \"excl_vat_per_unit\": \"\", // Required, type: float, accept: float, description: Price per unit excluding VAT.\n \"incl_vat_per_unit\": \"\" // Required, type: float, accept: float, description: Price per unit including VAT.\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{baseURL}}/items/:sequence_num","description":"

For 'unit' attribute allowed values are:
'tim', 'km', 'st', 'utl', 'kvm', 'förp'

\n

For 'vat' attribute allowed values are:

\n

0, 6, 12, 25

\n","urlObject":{"path":["items",":sequence_num"],"host":["{{baseURL}}"],"query":[],"variable":[{"description":{"content":"

Item 'sequence_num' required for updating particular item details.

\n","type":"text/plain"},"type":"any","value":"Any existing item sequence_num","key":"sequence_num"}]}},"response":[],"_postman_id":"b6dbef5e-c3df-42bc-b318-b24c1dd66f7e"},{"name":"Delete Item","id":"ee50198f-85dc-499c-ab68-85d7b2528a5d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"DELETE","header":[{"key":"Secret","value":"{{secret}}","type":"text"}],"url":"{{baseURL}}/items/:sequence_num","urlObject":{"path":["items",":sequence_num"],"host":["{{baseURL}}"],"query":[],"variable":[{"description":{"content":"

Item 'sequence_num' required for deleting particular item details.

\n","type":"text/plain"},"type":"any","value":"Any existing item sequence_num","key":"sequence_num"}]}},"response":[],"_postman_id":"ee50198f-85dc-499c-ab68-85d7b2528a5d"}],"id":"ea37ddc3-2b15-46ae-b1b6-7d63fd4e4059","_postman_id":"ea37ddc3-2b15-46ae-b1b6-7d63fd4e4059","description":""},{"name":"Order","item":[{"name":"Show Order","id":"fde8ae48-10e5-40c7-912b-d6e450413378","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{opentoken}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Secret","value":"{{secret}}","type":"text"}],"url":"{{baseURL}}/orders/:sequence_num","urlObject":{"path":["orders",":sequence_num"],"host":["{{baseURL}}"],"query":[],"variable":[{"description":{"content":"

Order 'sequence_num' required for getting particular order details

\n","type":"text/plain"},"type":"any","value":"Any existing order sequence_num","key":"sequence_num"}]}},"response":[],"_postman_id":"fde8ae48-10e5-40c7-912b-d6e450413378"},{"name":"Order list","id":"a94f3392-5e4d-4b46-a832-14403c8cdc2a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{opentoken}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Secret","value":"{{secret}}","type":"text"}],"url":"{{baseURL}}/orders?start_date=&end_date=&page=1&per_page=100&project_id=&customer_id=&service_id=&employee_id=","description":"

This endpoint list the order within a certain date range and according to filter params provided.
There are two categories of orders
1. order with id
2. order without id (virtual order)

\n

Params:

\n
    \n
  1. start_date (Required, Type: String)
    2. \n
  2. end_date (Required, Type: String)
    3. \n
  3. page (Optional, Type: Integer)
    4. \n
  4. per_page (Optional, Type: Interger, Limit: 100)
    5. \n
  5. project_id (Optional, Type: Integer) pass project's sequence_num
    6. \n
  6. customer_id (Optional, Type: String)
    7. \n
  7. service_id (Optional, Type: Strng)
    8. \n
  8. employee_id(Optional, Type: String)
    9. \n
\n","urlObject":{"path":["orders"],"host":["{{baseURL}}"],"query":[{"description":{"content":"

Filter by start date

\n","type":"text/plain"},"key":"start_date","value":""},{"description":{"content":"

Filter by end date

\n","type":"text/plain"},"key":"end_date","value":""},{"description":{"content":"

Page no of record

\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"

Limit 100 record per page base value 30

\n","type":"text/plain"},"key":"per_page","value":"100"},{"description":{"content":"

Filter by project sequence_num

\n","type":"text/plain"},"key":"project_id","value":""},{"description":{"content":"

Filter by customer id

\n","type":"text/plain"},"key":"customer_id","value":""},{"description":{"content":"

Filter by service id

\n","type":"text/plain"},"key":"service_id","value":""},{"description":{"content":"

Filter by employee id

\n","type":"text/plain"},"key":"employee_id","value":""}],"variable":[]}},"response":[],"_postman_id":"a94f3392-5e4d-4b46-a832-14403c8cdc2a"},{"name":"Create Order","id":"ba7544c7-2ff1-457d-accf-55b4620e39de","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{opentoken}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Secret","value":"{{secret}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"order\":{\n \"customer_id\": \"\", // Required, type: string, limite: 36, accept: string, description: Existing Customer id.\n \"service_id\": \"\", // Required, type: string, limite: 36, accept: string, description: Existing Service id.\n \"date\": \"\", // Required, type: string, limite: 10, accept: string, format: 'YYYY-MM-DD', description: Start Date of Order.\n \"time_type\": \"\", // Required, type: string, accept: string, description: Time type of order.\n \"start_time\": \"\", // Required, type: string, limite: 5, accept: string, format: 'HH:MM', description: Start Time of Order.\n \"end_time\": \"\", // Optional, type: string, limite: 5, accept: string, format: 'HH:MM', description: End Time of Order.\n \"total_hours\": \"\", // Required, type: string, limite: 5, accept: string, format: 'HH:MM', description: Total hours of order in case of time type total hours.\n \"flex_time_type\": \"\", // Required, type: string, accept: string, description: Flex time type of order in case of time type flex time.\n \"published\": null, // Optional, type: boolean, accept: boolean, description: \n \"price_type\": \"\", // Required, type: string, accept: string, description: To save price type of the Order.\n \"tax_reduction_type\": \"\", // Optional, type: string, accept: string, description: To save the tax reduction type of the Order.\n \"employee_confirmation_required\": null, // Optional, type: boolean, accept: boolean, description: To store employee confirmation of Order.\n \"sms_on_complete\": null,\n // Optional type: object, accept: object\n \"order_note_attributes\": { \n \"notes\": \"\" // Optional, type: string, accept: string, description: To save any notes for the Order.\n },\n // Optional, type: object, accept: object, description: When adding items to Order.\n \"order_items_attributes\": [ \n {\n \"title\": \"\", // Required, type: string, limite: 255, accept: string, description: item title.\n \"per_unit\": null, // Required, type: float, accept: string/float, description: price of item.\n \"material_cost\": null, // Optional, type: float, accept: string/float, description: total cost of metarial.\n \"housework_type\": \"\", // Optional, type: string, accept: string, description: house work type.\n \"is_housework\": \"\", // Optional, type: boolean, accept: boolead, description: true/false if itme is house work category.\n \"item_id\": \"\", // Optional, type: string, accept: string, description: Existing Item id.\n \"discount\": null, // Optional, type: float, accept: string/float, description: discount\n \"quantity\": null, // Required, type: integer, accept: string/integer, qunatity of item\n \"vat\": null, // Required, type: integer, limite: 100, accept: integer, decription: Item vat.\n \"unit\": \"\", // Required, type: string, limite: 255, accept: string, decription: Item unit.\n \"fortnox_id\": \"\", // Optional, type: string, limite: 255, accept: string, description: item's fortnox id\n \"visma_item_id\": \"\" // Required, type: string, limite: 255, accept: string, description: item's visma id\n }\n ]\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{baseURL}}/orders","description":"\n

Fields that accept particular set of values:

\n
    \n
  1. time_type (Required, Type: String)
    this field only accept specific_time, total_hours, flex_time these values
    Cases:
    1. When time_type is specific_time then start_time is required and total_hours, flex_time_type should not be passed in this case.
    2. When time_type is total_hours then total_hours is required and start_time, flex_time_type should not be passed in this case.
    3. When time_type is flex_time then flex_time_type is required and start_time, total_hours should not be passed in this case.
    2. \n
  2. flex_time_type (Required, Type: String)
    this field only accept flex, morning, afternoon, evening these values
    Case:
    this field is only required when time_type is flex_time
    3. \n
  3. price_type (Required, Type: String)
    this field only accept price_per_item, price_per_employee, fixed these values
    Cases:
    1. When price_type is price_per_item then invoice created is according to price of per item.
    2. When price_type is price_per_employee then invoice created is according to price of per employee working hours count.
    3. When price_type is fixed then invoice created is according to fixed total of items price.
    4. \n
  4. tax_reduction_type (Required, Type: String, Default value: None)
    this field only accept None, Rut, Rot these values which are tax reduction type
    5. \n
  5. Order items > housework_type (Optional, Type: String)
    Cases:
    1. When project's/order's tax_reduction_type is Rut this fields accept \"cleaning\", \"textile_clothing\", \"cooking\", \"snow_plowing\", \"gardening\", \"other_care\", \"tutoring\", \"it_services\", \"other_cost\", \"major_appliance_repair\", \"moving_services\", \"baby_sitting\", \"empty_housework\", \"furnishing\", \"home_maintenance\".
    2. When project's/order's tax_reduction_type is Rot this fields accept \"construction\", \"electricity\", \"glass_metal_work\", \"ground_drainage_work\", \"masonry\", \"painting_wallpapering\", \"hvac\", \"other_cost\".
    6. \n
  6. Order items > unit (Required, Type: String)
    this field only accept tim, km, st, utl, kvm, förp
    7. \n
  7. Order items > vat (Required, Type: Integer)
    this field accept 0, 6, 12, 25
    8. \n
\n

Fields that accept boolean values:

\n
    \n
  1. published (Optional, Type: Boolean, Default value: true)
    2. \n
  2. update_invoice_time (Optional, Type: Boolean, Default value: true)
    3. \n
  3. employee_confimation_required (Optional, Type: Booelan, Default value: true)
    4. \n
  4. sms_on_complete (Optional, Type: Boolean, Default value: false)
    5. \n
  5. Order items > is_housework (Optional, Type: Boolean)
    this field is expected to be true only when projects housework_type is Rut or Rot
    6. \n
\n

Fields that accept values within range or limit:

\n
    \n
  1. Order items > per_unit (Required, Type: Float)
    this field accept float greater than 0 and non negative value
    2. \n
  2. Order items > material_cost (Required, Type: Float)
    this field accept float greater than 0 and non negative value
    3. \n
  3. Order items > discount (Required, Type: Float)
    this field accept float greater than 0 and less than equal to 100 non negative value
    4. \n
  4. Order items > quantity (Required, Type: Float)
    this field accept float greater than 0 and less than equal to 1000 non negative value
    5. \n
\n

Fields that accept particular format

\n
    \n
  1. date (Required, Type: String)
    format \"YYYY-MM-DD\"YYYY = year for ex 2024
    MM = month for ex 01 to 12
    DD = date for ex 01 - 30/31
    2. \n
  2. start_time (Required, Type: String)
    format \"HH:MM\"HH = hours for ex 01:00 to 23:59
    MM = minutes for ex 01 to 59
    3. \n
  3. end_time (Optional, Type: String)
    format \"HH:MM\"
    HH = hours for ex 01:00 to 23:59
    MM = minutes for ex 01 to 59
    4. \n
  4. total_hours (Optional, Type: String)
    format \"YYYY-MM-DD\"YYYY = year for ex 2024
    MM = month for ex 01 to 12
    DD = date for ex 01 - 30/31
    5. \n
\n

Fields that accept valid string

\n
    \n

  1. **customer_id (Required, Type: String)**this field accept valid customer id limit 36 char.

    \n
    2. \n

  2. service_id (Required, Type: String)
    this field accept valid customer id limit 36 char.

    \n
    3. \n

  3. **Order note > notes (Optional, Type: String)**this field accept valid string.

    \n
    4. \n

  4. **Order items > title (Required, Type: String)**this field accept valid string limit 255 char.

    \n
    5. \n

  5. Order items > fortnox_id (Optional, Type: String)
    this fields accept fortnox item id in fortnox_id field in case of company integrated with fortnox.

    \n
    6. \n

  6. Order items > visma_item_id (Required, Type: String)
    this field accept visma item id in visma_item_id field in case of company integrated with visma.

    \n
    7. \n

  7. Order items > item_id (Optional, Type: String)
    this field accept existing item id in item_id field.

    \n
    8. \n
\n","urlObject":{"path":["orders"],"host":["{{baseURL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"ba7544c7-2ff1-457d-accf-55b4620e39de"},{"name":"Update Order","id":"13218c9e-4ff2-4547-aef9-78dea151e8a4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{opentoken}}"}]},"isInherited":false},"method":"PUT","header":[{"key":"Secret","value":"{{secret}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"order\":{\n \"customer_id\": \"\", // Required, type: string, limite: 36, accept: string, description: Existing Customer id.\n \"service_id\": \"\", // Required, type: string, limite: 36, accept: string, description: Existing Service id.\n \"date\": \"\", // Required, type: string, limite: 10, accept: string, format: 'YYYY-MM-DD', description: Start Date of Order.\n \"end_date\": \"\", // Optional, type: string, limite: 10, accept: string, format: 'YYYY-MM-DD', description: End Date of Order.\n \"time_type\": \"\", // Required, type: string, accept: string, description: Time type of order.\n \"start_time\": \"\", // Required, type: string, limite: 5, accept: string, format: 'HH:MM', description: Start Time of Order.\n \"end_time\": \"\", // Optional, type: string, limite: 5, accept: string, format: 'HH:MM', description: End Time of Order.\n \"total_hours\": \"\", // Required, type: string, limite: 5, accept: string, format: 'HH:MM', description: Total hours of Order in case of time type total hours.\n \"flex_time_type\": \"\", // Required, type: string, accept: string, description: Flex time type of order in case of time type flex time.\n \"published\": null, // Optional, type: boolean, accept: boolean, description: \n \"price_type\": \"\", // Required, type: string, accept: string, description: To save price type of the Order.\n \"tax_reduction_type\": \"\", // Optional, type: string, accept: string, description: To save the tax reduction type of the Order.\n \"employee_confirmation_required\": null, // Optional, type: boolean, accept: boolean, description: To store employee confirmation of Order.\n \"sms_on_complete\": null,\n // Optional type: object, accept: object\n \"order_note_attributes\": {\n \"id\": \"\", // Required, type: integer, accept: integer, description: To update the existing record of Order note.\n \"notes\": \"\", // Optional, type: string, accept: string, description: To save any notes for the Order.\n \"_destroy\": \"\" // Optional, type: boolean, accept: boolead, description: To delete the existing record of Order items.\n },\n // Optional, type: object, accept: object, description: When adding items to Order.\n \"order_items_attributes\": [ \n {\n \"id\": null, // Required, type: integer, accept: integer, description: To update the existing record of Order items.\n \"title\": \"\", // Required, type: string, limite: 255, accept: string, description: item title.\n \"per_unit\": null, // Required, type: float, accept: string/float, description: price of item.\n \"material_cost\": null, // Optional, type: float, accept: string/float, description: total cost of metarial.\n \"housework_type\": \"\", // Optional, type: string, accept: string, description: house work type.\n \"is_housework\": \"\", // Optional, type: boolean, accept: boolead, description: true/false if itme is house work category.\n \"item_id\": \"\", // Optional, type: string, accept: string, description: Existing Item id.\n \"discount\": null, // Optional, type: float, accept: string/float, description: discount\n \"quantity\": null, // Required, type: integer, accept: string/integer, qunatity of item\n \"vat\": null, // Required, type: integer, limite: 100, accept: integer, decription: Item vat.\n \"unit\": \"\", // Required, type: string, limite: 255, accept: string, decription: Item unit.\n \"fortnox_id\": \"\", // Optional, type: string, limite: 255, accept: string, description: item's fortnox id\n \"visma_item_id\": \"\", // Required, type: string, limite: 255, accept: string, description: item's visma id.\n \"_destroy\": \"\" // Optional, type: boolean, accept: boolead, description: To delete the existing record of order items.\n }\n ]\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{baseURL}}/orders/:sequence_num","description":"\n

Fields that accept particular set of values:

\n
    \n
  1. time_type (Required, Type: String)
    this field only accept specific_time, total_hours, flex_time these values
    Cases:
    1. When time_type is specific_time then start_time is required and total_hours, flex_time_type should not be passed in this case.
    2. When time_type is total_hours then total_hours is required and start_time, flex_time_type should not be passed in this case.
    3. When time_type is flex_time then flex_time_type is required and start_time, total_hours should not be passed in this case.
    2. \n
  2. flex_time_type (Required, Type: String)
    this field only accept flex, morning, afternoon, evening these values
    Case:
    this field is only required when time_type is flex_time
    3. \n
  3. price_type (Required, Type: String)
    this field only accept price_per_item, price_per_employee, fixed these values
    Cases:
    1. When price_type is price_per_item then invoice created is according to price of per item.
    2. When price_type is price_per_employee then invoice created is according to price of per employee working hours count.
    3. When price_type is fixed then invoice created is according to fixed total of items price.
    4. \n
  4. tax_reduction_type (Required, Type: String, Default value: None)
    this field only accept None, Rut, Rot these values which are tax reduction type
    5. \n
  5. Order items > housework_type (Optional, Type: String)
    Cases:
    1. When project's/order's tax_reduction_type is Rut this fields accept \"cleaning\", \"textile_clothing\", \"cooking\", \"snow_plowing\", \"gardening\", \"other_care\", \"tutoring\", \"it_services\", \"other_cost\", \"major_appliance_repair\", \"moving_services\", \"baby_sitting\", \"empty_housework\", \"furnishing\", \"home_maintenance\".
    2. When project's/order's tax_reduction_type is Rot this fields accept \"construction\", \"electricity\", \"glass_metal_work\", \"ground_drainage_work\", \"masonry\", \"painting_wallpapering\", \"hvac\", \"other_cost\".
    6. \n
  6. Order items > unit (Required, Type: String)
    this field only accept tim, km, st, utl, kvm, förp
    7. \n
  7. Order items > vat (Required, Type: Integer)
    this field accept 0, 6, 12, 25
    8. \n
\n

Fields that accept boolean values:

\n
    \n
  1. published (Optional, Type: Boolean, Default value: true)
    2. \n
  2. update_invoice_time (Optional, Type: Boolean, Default value: true)
    3. \n
  3. employee_confimation_required (Optional, Type: Booelan, Default value: true)
    4. \n
  4. sms_on_complete (Optional, Type: Boolean, Default value: false)
    5. \n
  5. Order items > is_housework (Optional, Type: Boolean)
    this field is expected to be true only when projects housework_type is Rut or Rot
    6. \n
\n

Fields that accept values within range or limit:

\n
    \n
  1. Order items > per_unit (Required, Type: Float)
    this field accept float greater than 0 and non negative value
    2. \n
  2. Order items > material_cost (Required, Type: Float)
    this field accept float greater than 0 and non negative value
    3. \n
  3. Order items > discount (Required, Type: Float)
    this field accept float greater than 0 and less than equal to 100 non negative value
    4. \n
  4. Order items > quantity (Required, Type: Float)
    this field accept float greater than 0 and less than equal to 1000 non negative value
    5. \n
\n

Fields that accept particular format

\n
    \n
  1. date (Required, Type: String)
    format \"YYYY-MM-DD\"YYYY = year for ex 2024
    MM = month for ex 01 to 12
    DD = date for ex 01 - 30/31
    2. \n
  2. start_time (Required, Type: String)
    format \"HH:MM\"HH = hours for ex 01:00 to 23:59
    MM = minutes for ex 01 to 59
    3. \n
  3. end_time (Optional, Type: String)
    format \"HH:MM\"
    HH = hours for ex 01:00 to 23:59
    MM = minutes for ex 01 to 59
    4. \n
  4. total_hours (Optional, Type: String)
    format \"YYYY-MM-DD\"YYYY = year for ex 2024
    MM = month for ex 01 to 12
    DD = date for ex 01 - 30/31
    5. \n
\n

Fields that accept valid string

\n
    \n

  1. **customer_id (Required, Type: String)**this field accept valid customer id limit 36 char.

    \n
    2. \n

  2. service_id (Required, Type: String)
    this field accept valid customer id limit 36 char.

    \n
    3. \n

  3. **Order note > notes (Optional, Type: String)**this field accept valid string.

    \n
    4. \n

  4. **Order items > title (Required, Type: String)**this field accept valid string limit 255 char.

    \n
    5. \n

  5. Order items > fortnox_id (Optional, Type: String)
    this fields accept fortnox item id in fortnox_id field in case of company integrated with fortnox.

    \n
    6. \n

  6. Order items > visma_item_id (Required, Type: String)
    this field accept visma item id in visma_item_id field in case of company integrated with visma.

    \n
    7. \n

  7. Order items > item_id (Optional, Type: String)
    this field accept existing item id in item_id field.

    \n
    8. \n
\n","urlObject":{"path":["orders",":sequence_num"],"host":["{{baseURL}}"],"query":[],"variable":[{"description":{"content":"

Order 'sequence_num' required for deleting particular project details.

\n","type":"text/plain"},"type":"any","value":"Any existing order sequence_num","key":"sequence_num"}]}},"response":[],"_postman_id":"13218c9e-4ff2-4547-aef9-78dea151e8a4"},{"name":"Destroy Order","id":"9a35b67b-f6eb-40cd-acd9-500612b95b9e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{opentoken}}"}]},"isInherited":false},"method":"DELETE","header":[{"key":"Secret","value":"{{secret}}","type":"text"}],"url":"{{baseURL}}/orders/:sequence_num","urlObject":{"path":["orders",":sequence_num"],"host":["{{baseURL}}"],"query":[],"variable":[{"description":{"content":"

Order 'sequence_num' required for deleting particular order details.

\n","type":"text/plain"},"type":"any","value":"Any existing project sequence_num","key":"sequence_num"}]}},"response":[],"_postman_id":"9a35b67b-f6eb-40cd-acd9-500612b95b9e"}],"id":"4016a820-1d6c-42e7-b924-25382e5db5da","_postman_id":"4016a820-1d6c-42e7-b924-25382e5db5da","description":""},{"name":"Projects","item":[{"name":"Show Project","id":"07b20a6d-c827-45d3-9e19-e1834f64a673","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{opentoken}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Secret","value":"{{secret}}","type":"text"}],"url":"{{baseURL}}/projects/:sequence_num","urlObject":{"path":["projects",":sequence_num"],"host":["{{baseURL}}"],"query":[],"variable":[{"description":{"content":"

Project 'sequence_num' required for getting particular project details.

\n","type":"text/plain"},"type":"any","value":"Any existing project sequence_num","key":"sequence_num"}]}},"response":[],"_postman_id":"07b20a6d-c827-45d3-9e19-e1834f64a673"},{"name":"Project list","id":"38831331-6733-4248-bbc0-8d51c1fee01a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{opentoken}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Secret","value":"{{secret}}","type":"text"}],"url":"{{baseURL}}/projects?start_date=&end_date=&page=1&per_page=10&project_id=&customer_id=&service_id&employee_id=","description":"

Params:

\n
    \n

  1. start_date (Required, Type: String)

    \n
    2. \n

  2. end_date (Required, Type: String)

    \n
    3. \n

  3. page (Optional, Type: Integer)

    \n
    4. \n

  4. per_page (Optional, Type: Interger, Limit: 100)

    \n
    5. \n

  5. project_id (Optional, Type: Integer) pass project's sequence_num

    \n
    6. \n

  6. customer_id (Optional, Type: String)

    \n
    7. \n

  7. service_id (Optional, Type: String)

    \n
    8. \n

  8. employee_id(Optional, Type: String)

    \n
    9. \n
\n","urlObject":{"path":["projects"],"host":["{{baseURL}}"],"query":[{"description":{"content":"

Filter by start date

\n","type":"text/plain"},"key":"start_date","value":""},{"description":{"content":"

Filter by end date

\n","type":"text/plain"},"key":"end_date","value":""},{"description":{"content":"

Page no of record

\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"

Limit 100 record per page base value 30

\n","type":"text/plain"},"key":"per_page","value":"10"},{"description":{"content":"

Filter by project id

\n","type":"text/plain"},"key":"project_id","value":""},{"description":{"content":"

Filter by customer id

\n","type":"text/plain"},"key":"customer_id","value":""},{"description":{"content":"

Filter by service id

\n","type":"text/plain"},"key":"service_id","value":null},{"description":{"content":"

Filter by employee id

\n","type":"text/plain"},"key":"employee_id","value":""}],"variable":[]}},"response":[],"_postman_id":"38831331-6733-4248-bbc0-8d51c1fee01a"},{"name":"Create Project","id":"c61b5f39-5954-4839-a989-99f4a65ae0c4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{opentoken}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Secret","value":"{{secret}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"project\":{ \n \"customer_id\": \"\", // Required, type: string, limite: 36, accept: string, description: Existing Customer id.\n \"service_id\": \"\", // Required, type: string, limite: 36, accept: string, description: Existing Service id.\n \"start_date\": \"\", // Required, type: string, limite: 10, accept: string, format: 'YYYY-MM-DD', description: Start Date of Project.\n \"end_date\": \"\", // Optional, type: string, limite: 10, accept: string, format: 'YYYY-MM-DD', description: End Date of Project.\n \"time_type\": \"\", // Required, type: string, accept: string, description: Time type of Project.\n \"start_time\": \"\", // Required, type: string, limite: 5, accept: string, format: 'HH:MM', description: Start Time of Project.\n \"end_time\": \"\", // Optional, type: string, limite: 5, accept: string, format: 'HH:MM', description: End Time of Project.\n \"total_hours\": \"\", // Required, type: string, limite: 5, accept: string, format: 'HH:MM', description: Total hours of Project in case of time type total hours.\n \"flex_time_type\": \"\", // Required, type: string, accept: string, description: Flex time type of Project in case of time type flex time.\n \"published\": \"\", // Optional, type: boolean, accept: boolean, description: \n \"price_type\": \"\", // Required, type: string, accept: string, description: To save price type of the project.\n \"tax_reduction_type\": \"\", // Optional, type: string, accept: string, description: To save the tax reduction type of the Project.\n \"employee_confirmation_required\": \"\" ,\n \"sms_on_complete\": \"\", // Optional, type: boolean, accept: boolean, description: To store employee confirmation of Project.\n // Optional type: object, accept: object\n \"project_note_attributes\": { \n \"notes\": \"\" // Optional, type: string, accept: string, description: To save any notes for the Project.\n },\n // // Optional type: object, accept: object\n \"project_recurring_rule_attributes\": { \n \"repeat_type\": \"\", // Required, type: string, accept: string, description: To save repeat type of Project \n \"repeat_days\": [\"\"], // Required, type: array of string, accept: array of string, description: To save days of the week in case of repeat type week.\n \"month_repeat\": \"\", // Required, type: string, accept: string, description: To save type of month repeat day/date in case of repeat type month.\n \"repeat_interval\": null // Required, type: integer, accept: integer, description: To save repeat interval of the Project.\n },\n // // Optional, type: object, accept: object, description: When adding items to project.\n \"project_items_attributes\": [ \n {\n \"title\": \"\", // Required, type: string, limite: 255, accept: string, description: item title.\n \"per_unit\": null, // Required, type: float, accept: string/float, description: price of item.\n \"material_cost\": null, // Optional, type: float, accept: string/float, description: total cost of metarial.\n \"housework_type\": \"\", // Optional, type: string, accept: string, description: house work type.\n \"is_housework\": null, // Optional, type: boolean, accept: boolead, description: true/false if itme is house work category.\n \"item_id\": \"\", // Optional, type: string, accept: string, description: Existing Item id.\n \"discount\": null, // Optional, type: float, accept: string/float, description: discount\n \"quantity\": null, // Required, type: integer, accept: string/integer, description: qunatity of item\n \"vat\": null, // Required, type: integer, limite: 100, accept: integer, description: Item vat.\n \"unit\": \"\", // Required, type: string, limite: 255, accept: string, description: Item unit.\n \"fortnox_id\": \"\", // Required, type: string, limite: 255, accept: string, description: item's fortnox id\n \"visma_item_id\": \"\" // Required, type: string, limite: 255, accept: string, description: item's visma id\n }\n ]\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{baseURL}}/projects","description":"

For Project related fields

\n

Fields that accept particular set of values:

\n
    \n

  1. time_type (Required, Type: String)
    this field only accept specific_time, total_hours, flex_time these values
    Cases:
    1. When time_type is specific_time then start_time is required and total_hours, flex_time_type should not be passed in this case.
    2. When time_type is total_hours then total_hours is required and start_time, flex_time_type should not be passed in this case.
    3. When time_type is flex_time then flex_time_type is required and start_time, total_hours should not be passed in this case.

    \n
    2. \n

  2. flex_time_type (Required, Type: String)
    this field only accept flex, morning, afternoon, evening these values
    Case:
    this field is only required when time_type is flex_time

    \n
    3. \n

  3. price_type (Required, Type: String)
    this field only accept price_per_item, price_per_employee, fixed these values
    Cases:
    1. When price_type is price_per_item then invoice created is according to price of per item.
    2. When price_type is price_per_employee then invoice created is according to price of per employee working hours count.
    3. When price_type is fixed then invoice created is according to fixed total of items price.

    \n
    4. \n

  4. tax_reduction_type (Required, Type: String, Default value: None)
    this field only accept None, Rut, Rot these values which are tax reduction type

    \n
    5. \n

  5. Project recurring rule > repeat_type (Required, Type: String)
    this field only accept week, month these values
    Cases:
    1. When repeat_type is week then repeat_days is required and month_repeat should not be passed in this case.
    2. When repeat_type is month then month_repeat is required and repeat_days should not be passed in this case.

    \n
    6. \n

  6. Project recurring rule > repeat_days (Required, Type: Array of string)
    this field only accept array of week days sunday, monday, tuesday, wednesday, thursday, friday, saturday

    \n
    7. \n

  7. Project recurring rule > month_repeat (Required, Type: String)
    this field only accept day, date these values

    \n
    8. \n

  8. Project items > housework_type (Optional, Type: String)
    Cases:
    1. When project's/order's tax_reduction_type is Rut this fields accept \"cleaning\", \"textile_clothing\", \"cooking\", \"snow_plowing\", \"gardening\", \"other_care\", \"tutoring\", \"it_services\", \"other_cost\", \"major_appliance_repair\", \"moving_services\", \"baby_sitting\", \"empty_housework\", \"furnishing\", \"home_maintenance\".
    2. When project's/order's tax_reduction_type is Rot this fields accept \"construction\", \"electricity\", \"glass_metal_work\", \"ground_drainage_work\", \"masonry\", \"painting_wallpapering\", \"hvac\", \"other_cost\".

    \n
    9. \n

  9. Project items > unit (Required, Type: String)
    this field only accept tim, km, st, utl, kvm, förp

    \n
    10. \n

  10. Project items > vat (Required, Type: Integer)
    this field accept 0, 6, 12, 25

    \n
    11. \n
\n

Fields that accept boolean values:

\n
    \n

  1. published (Optional, Type: Boolean, Default value: true)

    \n
    2. \n

  2. update_invoice_time (Optional, Type: Boolean, Default value: true)

    \n
    3. \n

  3. employee_confimation_required (Optional, Type: Booelan, Default value: true)

    \n
    4. \n

  4. sms_on_complete (Optional, Type: Boolean, Default value: false)

    \n
    5. \n

  5. Project items > is_housework (Optional, Type: Boolean)
    this field is expected to be true only when projects housework_type is Rut or Rot

    \n
    6. \n
\n

Fields that accept values within range or limit:

\n
    \n

  1. Project recurring rule > repeat_interval (Required, Type: Integer)
    this field accept number range from 1 to 12 and non negative value

    \n
    2. \n

  2. Project items > per_unit (Required, Type: Float)
    this field accept float greater than 0 and non negative value

    \n
    3. \n

  3. Project items > material_cost (Required, Type: Float)
    this field accept float greater than 0 and non negative value

    \n
    4. \n

  4. Project items > discount (Required, Type: Float)
    this field accept float greater than 0 and less than equal to 100 non negative value

    \n
    5. \n

  5. Project items > quantity (Required, Type: Float)
    this field accept float greater than 0 and less than equal to 1000 non negative value

    \n
    6. \n
\n

Fields that accept particular format

\n
    \n

  1. start_date (Required, Type: String)
    format \"YYYY-MM-DD\"YYYY = year for ex 2024
    MM = month for ex 01 to 12
    DD = date for ex 01 - 30/31

    \n
    2. \n

  2. end_date (Optional, Type: String)
    format \"YYYY-MM-DD\"
    YYYY = year for ex 2024
    MM = month for ex 01 to 12
    DD = date for ex 01 - 30/31

    \n
    3. \n

  3. start_time (Required, Type: String)
    format \"HH:MM\"HH = hours for ex 01:00 to 23:59
    MM = minutes for ex 01 to 59

    \n
    4. \n

  4. end_time (Optional, Type: String)
    format \"HH:MM\"
    HH = hours for ex 01:00 to 23:59
    MM = minutes for ex 01 to 59

    \n
    5. \n
\n

Fields that accept valid string

\n
    \n

  1. **customer_id (Required, Type: String)**this field accept valid customer id limit 36 char.

    \n
    2. \n

  2. service_id (Required, Type: String)
    this field accept valid customer id limit 36 char.

    \n
    3. \n

  3. **Project note > notes (Optional, Type: String)**this field accept valid string.

    \n
    4. \n

  4. **Project items > title (Required, Type: String)**this field accept valid string limit 255 char.

    \n
    5. \n

  5. Project items > fortnox_id (Optional, Type: String)
    this fields accept fortnox item id in fortnox_id field in case of company integrated with fortnox.

    \n
    6. \n

  6. Project items > visma_item_id (Required, Type: String)
    this field accept visma item id in visma_item_id field in case of company integrated with visma.

    \n
    7. \n

  7. Order items > item_id (Optional, Type: String)
    this field accept existing item id in item_id field.

    \n
    8. \n
\n","urlObject":{"path":["projects"],"host":["{{baseURL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"c61b5f39-5954-4839-a989-99f4a65ae0c4"},{"name":"Update Project","id":"49d9fee9-5598-4d51-ad0b-e9ce5a105ed6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{opentoken}}"}]},"isInherited":false},"method":"PUT","header":[{"key":"Secret","value":"{{secret}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"project\":{\n \"customer_id\": \"\", // Required, type: string, limite: 36, accept: string, description: Existing Customer id.\n \"service_id\": \"\", // Required, type: string, limite: 36, accept: string, description: Existing Service id.\n \"start_date\": \"\", // Required, type: string, limite: 10, accept: string, format: 'YYYY-MM-DD', description: Start Date of Project.\n \"end_date\": \"\", // Optional, type: string, limite: 10, accept: string, format: 'YYYY-MM-DD', description: End Date of Project.\n \"time_type\": \"\", // Required, type: string, accept: string, description: Time type of Project.\n \"start_time\": \"\", // Required, type: string, limite: 5, accept: string, format: 'HH:MM', description: Start Time of Project.\n \"end_time\": \"\", // Optional, type: string, limite: 5, accept: string, format: 'HH:MM', description: End Time of Project.\n \"total_hours\": \"\", // Required, type: string, limite: 5, accept: string, format: 'HH:MM', description: Total hours of Project in case of time type total hours.\n \"flex_time_type\": \"\", // Required, type: string, accept: string, description: Flex time type of Project in case of time type flex time.\n \"published\": \"\", // Optional, type: boolean, accept: boolean, description: \n \"price_type\": \"\", // Required, type: string, accept: string, description: To save price type of the project.\n \"tax_reduction_type\": \"\", // Optional, type: string, accept: string, description: To save the tax reduction type of the Project.\n \"employee_confirmation_required\": \"\", // Optional, type: boolean, accept: boolean, description: To store employee confirmation of Project.\n // Optional type: object, accept: object\n \"project_note_attributes\": {\n \"id\": \"\", // Required, type: integer, accept: integer, description: To update the existing record of Project note.\n \"notes\": \"\", // Optional, type: string, accept: string, description: To save any notes for the Project.\n \"_destroy\": \"\" // Optional, type: boolean, accept: boolead, description: To delete the existing record of Project items.\n },\n // Optional, type: object, accept: object, description: When adding items to project.\n \"project_items_attributes\": [ \n {\n \"id\": \"\", // Required, type: integer, accept: integer, description: To update the existing record of Project items.\n \"title\": \"\", // Required, type: string, limite: 255, accept: string, description: item title.\n \"per_unit\": \"\", // Required, type: float, accept: string/float, description: price of item.\n \"material_cost\": \"\", // Optional, type: float, accept: string/float, description: total cost of metarial.\n \"housework_type\": \"\", // Optional, type: string, accept: string, description: house work type.\n \"is_housework\": \"\", // Optional, type: boolean, accept: boolead, description: true/false if itme is house work category.\n \"item_id\": \"\", // Optional, type: string, accept: string, description: Existing Item id.\n \"discount\": \"\", // Optional, type: float, accept: string/float, description: discount\n \"quantity\": 3, // Required, type: integer, accept: string/integer, qunatity of item\n \"vat\": 12, // Required, type: integer, limite: 100, accept: integer, decription: Item vat.\n \"unit\": \"\", // Required, type: string, limite: 255, accept: string, decription: Item unit.\n \"fortnox_id\": \"\", // Optional, type: string, limite: 255, accept: string, description: item's fortnox id\n \"visma_item_id\": \"\", // Required, type: string, limite: 255, accept: string, description: item's visma id.\n \"_destroy\": \"\" // Optional, type: boolean, accept: boolead, description: To delete the existing record of Project items.\n }\n ]\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{baseURL}}/projects/:sequence_num","description":"\n

Fields that accept particular set of values:

\n
    \n

  1. time_type (Required, Type: String)
    this field only accept specific_time, total_hours, flex_time these values
    Cases:
    1. When time_type is specific_time then start_time is required and total_hours, flex_time_type should not be passed in this case.
    2. When time_type is total_hours then total_hours is required and start_time, flex_time_type should not be passed in this case.
    3. When time_type is flex_time then flex_time_type is required and start_time, total_hours should not be passed in this case.

    \n
    2. \n

  2. flex_time_type (Required, Type: String)
    this field only accept flex, morning, afternoon, evening these values
    Case:
    this field is only required when time_type is flex_time

    \n
    3. \n

  3. price_type (Required, Type: String)
    this field only accept price_per_item, price_per_employee, fixed these values
    Cases:
    1. When price_type is price_per_item then invoice created is according to price of per item.
    2. When price_type is price_per_employee then invoice created is according to price of per employee working hours count.
    3. When price_type is fixed then invoice created is according to fixed total of items price.

    \n
    4. \n

  4. tax_reduction_type (Required, Type: String, Default value: None)
    this field only accept None, Rut, Rot these values which are tax reduction type

    \n
    5. \n

  5. Project items > housework_type (Optional, Type: String)
    Cases:
    1. When project's/order's tax_reduction_type is Rut this fields accept \"cleaning\", \"textile_clothing\", \"cooking\", \"snow_plowing\", \"gardening\", \"other_care\", \"tutoring\", \"it_services\", \"other_cost\", \"major_appliance_repair\", \"moving_services\", \"baby_sitting\", \"empty_housework\", \"furnishing\", \"home_maintenance\".
    2. When project's/order's tax_reduction_type is Rot this fields accept \"construction\", \"electricity\", \"glass_metal_work\", \"ground_drainage_work\", \"masonry\", \"painting_wallpapering\", \"hvac\", \"other_cost\".

    \n
    6. \n

  6. Project items > unit (Required, Type: String)
    this field only accept tim, km, st, utl, kvm, förp

    \n
    7. \n

  7. Project items > vat (Required, Type: Integer)
    this field accept 0, 6, 12, 25

    \n
    8. \n
\n

Fields that accept boolean values:

\n
    \n

  1. published (Optional, Type: Boolean, Default value: true)

    \n
    2. \n

  2. update_invoice_time (Optional, Type: Boolean, Default value: true)

    \n
    3. \n

  3. employee_confimation_required (Optional, Type: Booelan, Default value: true)

    \n
    4. \n

  4. sms_on_complete (Optional, Type: Boolean, Default value: false)

    \n
    5. \n

  5. Project items > is_housework (Optional, Type: Boolean)
    this field is expected to be true only when projects housework_type is Rut or Rot

    \n
    6. \n
\n

Fields that accept values within range or limit:

\n
    \n

  1. Project items > per_unit (Required, Type: Float)
    this field accept float greater than 0 and non negative value

    \n
    2. \n

  2. Project items > material_cost (Required, Type: Float)
    this field accept float greater than 0 and non negative value

    \n
    3. \n

  3. Project items > discount (Required, Type: Float)
    this field accept float greater than 0 and less than equal to 100 non negative value

    \n
    4. \n

  4. Project items > quantity (Required, Type: Float)
    this field accept float greater than 0 and less than equal to 1000 non negative value

    \n
    5. \n
\n

Fields that accept particular format

\n
    \n

  1. start_date (Required, Type: String)
    format \"YYYY-MM-DD\"YYYY = year for ex 2024
    MM = month for ex 01 to 12
    DD = date for ex 01 - 30/31

    \n
    2. \n

  2. end_date (Optional, Type: String)
    format \"YYYY-MM-DD\"
    YYYY = year for ex 2024
    MM = month for ex 01 to 12
    DD = date for ex 01 - 30/31

    \n
    3. \n

  3. start_time (Required, Type: String)
    format \"HH:MM\"HH = hours for ex 01:00 to 23:59
    MM = minutes for ex 01 to 59

    \n
    4. \n

  4. end_time (Optional, Type: String)
    format \"HH:MM\"
    HH = hours for ex 01:00 to 23:59
    MM = minutes for ex 01 to 59

    \n
    5. \n
\n

Fields that accept valid string

\n
    \n

  1. **customer_id (Required, Type: String)**this field accept valid customer id limit 36 char.

    \n
    2. \n

  2. service_id (Required, Type: String)
    this field accept valid customer id limit 36 char.

    \n
    3. \n

  3. **Project note > notes (Optional, Type: String)**this field accept valid string.

    \n
    4. \n

  4. **Project items > title (Required, Type: String)**this field accept valid string limit 255 char.

    \n
    5. \n

  5. Project items > fortnox_id (Optional, Type: String)
    this fields accept fortnox item id in fortnox_id field in case of company integrated with fortnox.

    \n
    6. \n

  6. Project items > visma_item_id (Required, Type: String)
    this field accept visma item id in visma_item_id field in case of company integrated with visma.

    \n
    7. \n

  7. Order items > item_id (Optional, Type: String)
    this field accept existing item id in item_id field.

    \n
    8. \n
\n","urlObject":{"path":["projects",":sequence_num"],"host":["{{baseURL}}"],"query":[],"variable":[{"description":{"content":"

Project 'sequence_num' required for updating particular project details.

\n","type":"text/plain"},"type":"any","value":"Any existing project sequence_num","key":"sequence_num"}]}},"response":[],"_postman_id":"49d9fee9-5598-4d51-ad0b-e9ce5a105ed6"},{"name":"Destroy Project","id":"e45581d5-8595-481e-9e78-160cee10fcf5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{opentoken}}"}]},"isInherited":false},"method":"DELETE","header":[{"key":"Secret","value":"{{secret}}","type":"text"}],"url":"{{baseURL}}/projects/:sequence_num","urlObject":{"path":["projects",":sequence_num"],"host":["{{baseURL}}"],"query":[],"variable":[{"description":{"content":"

Project 'sequence_num' required for deleting particular project details.

\n","type":"text/plain"},"type":"any","value":"Any existing project sequence_num","key":"sequence_num"}]}},"response":[],"_postman_id":"e45581d5-8595-481e-9e78-160cee10fcf5"}],"id":"2c46736b-abee-4e9d-b559-d3ff16fa1f9a","_postman_id":"2c46736b-abee-4e9d-b559-d3ff16fa1f9a","description":""},{"name":"Projects Recurring Rule","item":[{"name":"Add Recurring Rule","id":"2c55019d-0c9b-4adc-8a2d-dafd58a19939","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{opentoken}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Secret","value":"{{secret}}","type":"text"}],"body":{"mode":"raw","raw":"{ \n \"recurring_rule\": {\n \"repeat_type\": \"week\", // Required, type: string, accept: string, description: To save repeat type of Project\n \"repeat_days\": [\"\"], // Required, type: array of string, accept: array of string, description: To save days of the week in case of repeat type week.\n \"repeat_interval\": null, // Required, type: integer, accept: integer, description: To save repeat interval of the Project.\n \"month_repeat\": \"\" // Required, type: string, accept: string, description: To save type of month repeat day/date in case of repeat type month.\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{baseURL}}/projects/:sequence_num/add_recurring_rule","description":"

For Project related fields

\n

Fields that accept particular set of values:

\n
    \n

  1. repeat_type (Required, Type: String)
    this field only accept week, month these values
    Cases:
    1. When repeat_type is week then repeat_days is required and month_repeat should not be passed in this case.
    2. When repeat_type is month then month_repeat is required and repeat_days should not be passed in this case.

    \n
    2. \n

  2. repeat_days (Required, Type: Array of string)
    this field only accept array of week days sunday, monday, tuesday, wednesday, thursday, friday, saturday

    \n
    3. \n

  3. month_repeat (Required, Type: String)
    this field only accept day, date these values

    \n
    4. \n
\n

Fields that accept values within range or limit:

\n
    \n
  1. repeat_interval (Required, Type: Integer)
    this field accept number range from 1 to 12 and non negative value
    2. \n
\n","urlObject":{"path":["projects",":sequence_num","add_recurring_rule"],"host":["{{baseURL}}"],"query":[],"variable":[{"description":{"content":"

Project 'sequence_num' required for adding recurring rule to any project.

\n","type":"text/plain"},"type":"any","value":"Any existing project sequence_num","key":"sequence_num"}]}},"response":[],"_postman_id":"2c55019d-0c9b-4adc-8a2d-dafd58a19939"},{"name":"Update Recurring Rule","id":"71ac13de-abf7-4560-81b8-5bee48976082","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{opentoken}}"}]},"isInherited":false},"method":"PUT","header":[{"key":"Secret","value":"{{secret}}","type":"text"}],"body":{"mode":"raw","raw":"{ \n \"recurring_rule\": {\n \"id\": \"\", // Required, type: integer, accept: integer, description: To update the existing record of Project recurring rule.\n \"repeat_days\": [\"\"], // Required, type: array of string, accept: array of string, description: To save days of the week in case of repeat type week.\n \"repeat_interval\": null, // Required, type: integer, accept: integer, description: To save repeat interval of the Project.\n \"month_repeat\": \"\" // Required, type: string, accept: string, description: To save type of month repeat day/date in case of repeat type month.\n },\n \"remove_past_order\": true // Optional, type: boolean, accept: boolean, description: To remove all past active orders associated with the project before applying the updated recurring rule date.\n}","options":{"raw":{"language":"json"}}},"url":"{{baseURL}}/projects/:sequence_num/update_recurring_rule","description":"\n

Fields that accept particular set of values:

\n
    \n

  1. repeat_days (Required, Type: Array of string)
    this field only accept array of week days sunday, monday, tuesday, wednesday, thursday, friday, saturday

    \n
    2. \n

  2. month_repeat (Required, Type: String)
    this field only accept day, date these values

    \n
    3. \n
\n

Fields that accept values within range or limit:

\n
    \n
  1. repeat_interval (Required, Type: Integer)
    this field accept number range from 1 to 12 and non negative value
    2. \n
\n

Fields that accept boolean values:

\n
    \n
  1. remove_past_order (Optional, Type: Boolean)
    2. \n
\n","urlObject":{"path":["projects",":sequence_num","update_recurring_rule"],"host":["{{baseURL}}"],"query":[],"variable":[{"description":{"content":"

Project 'sequence_num' required for updating recurring rule to any project.

\n","type":"text/plain"},"type":"any","value":"Any existing project sequence_num","key":"sequence_num"}]}},"response":[],"_postman_id":"71ac13de-abf7-4560-81b8-5bee48976082"},{"name":"Destroy Recurring Rule","id":"f3276dc7-3ac0-43d7-b343-71f2c37a9a88","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{opentoken}}"}]},"isInherited":false},"method":"DELETE","header":[{"key":"Secret","value":"{{secret}}","type":"text"}],"url":"{{baseURL}}/projects/:sequence_num/delete_recurring_rule","urlObject":{"path":["projects",":sequence_num","delete_recurring_rule"],"host":["{{baseURL}}"],"query":[],"variable":[{"description":{"content":"

Project 'sequence_num' required for removing recurring rule to any project.

\n","type":"text/plain"},"type":"any","value":"Any existing project sequence_num","key":"sequence_num"}]}},"response":[],"_postman_id":"f3276dc7-3ac0-43d7-b343-71f2c37a9a88"}],"id":"0c0aa752-d38f-4f61-8fd9-1cdf2b2b17a7","_postman_id":"0c0aa752-d38f-4f61-8fd9-1cdf2b2b17a7","description":""}],"id":"790086b3-75c1-42af-9f97-65be1adfe334","description":"

Getting Started:

\n

To begin using our APIs, please follow the steps below:

\n

1. Signup: To access our APIs, you must first sign up on the Booking & Schema online platform.

\n

2. Upgrade: After signing up, you will receive a 14-day trial. However, please note that this feature is only available to paid companies. Therefore, you will need to sign a contract to upgrade and gain access to our APIs.

\n

3. Activate API: Once you have upgraded, you can activate the API from the settings page. Make sure to copy the secret and token before closing the dialog, as it will only be visible once.

\n

Note
It's important to note that our API directly communicates with your actual account on the Booking & Schema online platform. This means that any changes made using the endpoints will affect the actual objects in your account. Please be aware that a sandbox version for development and testing will be available soon.

\n

How to Use Secret and Token:
Each requests sent to Booking and Schema online api must contain the token and secret in the request headers for authorization:

\n\n

If you have any queries please drop us an email at: developer@birdvision.se

\n","_postman_id":"790086b3-75c1-42af-9f97-65be1adfe334"}]}