When a user sets up an estimate or project/job, they accept a connection to the BuiltGrid network, which they can select or unselect. Once saved and updated, you will use our endpoints to sync the following data.
\nWhen docs are added or updated for a project, the endpoint triggers and makes the latest versions available for applicable trades and suppliers on the BuiltGrid network.
\nThis is an optional endpoint used to check if a project exists on the BuiltGrid server before opening your RFQ page.
\nIt only requires your project_id, the unique project_id set by your system.
\n","urlObject":{"path":["api","project","CheckProject"],"host":["{{base_url}}"],"query":[{"key":"project_id","value":"TestingNewEndpoints"}],"variable":[]}},"response":[],"_postman_id":"fe68eae8-d996-4ae0-84de-9ed87b214fad"},{"name":"Retrieve document status","id":"9cbafc6f-2af4-43eb-a33d-458483d6121e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{base_url}}/api/project/CheckProjectDocument?project_id=TestingNewEndpoints","description":"This is an optional endpoint used to check if a project exists on the BuiltGrid server before opening your RFQ page.
\nIt only requires your project_id, the unique project_id set by your system.
\n","urlObject":{"path":["api","project","CheckProjectDocument"],"host":["{{base_url}}"],"query":[{"key":"project_id","value":"TestingNewEndpoints"}],"variable":[]}},"response":[],"_postman_id":"9cbafc6f-2af4-43eb-a33d-458483d6121e"},{"name":"Check Project Doc is created on BGD","id":"d9eb8630-898a-467d-b25d-6ad2fe4ef38d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{base_url}}/api/project/CheckProjectDocumentCreated?project_id=TestingNewEndpoints","description":"This is an optional endpoint used to check if a project exists on the BuiltGrid server before opening your RFQ page.
\nIt only requires your project_id, the unique project_id set by your system.
\n","urlObject":{"path":["api","project","CheckProjectDocumentCreated"],"host":["{{base_url}}"],"query":[{"key":"project_id","value":"TestingNewEndpoints"}],"variable":[]}},"response":[],"_postman_id":"d9eb8630-898a-467d-b25d-6ad2fe4ef38d"}],"id":"5e225534-64a4-4cdc-9115-50b9aa195313","description":"When a user sets up a contracted project/job or estimate, a connection to the 'BuiltGrid network' is established. The user may disconnect it. Once the 'BuiltGrid network' is connected at the project level, it will be added as an invited supplier to every RFQ associated with the project. The user can optionally remove it from the RFQ invited suppliers.
\n"}]},"isInherited":true,"source":{"_postman_id":"5bc456b8-aae3-4110-812d-6b125b35bbb2","id":"5bc456b8-aae3-4110-812d-6b125b35bbb2","name":"BuiltGrid - Builder Apps","type":"collection"}}},{"name":"RFQ (Request for quote)","item":[{"name":"Create or update a request for quote","id":"4a7461e1-25b2-4981-9c20-5fb89c5a8e59","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"data\": [\n {\n \"rfq_id\": \"RFQ-TestingNewEndpoints2\",\n \"project_id\": \"TestingNewEndpoints2\",\n \"rfq_title\": \"Electrician\",\n \"rfq_cost_code_name\": \"\",\n \"rfq_supplier_id\": \"TestingNewEndpoints2\",\n \"rfq_response_date\": \"2024-07-15\",\n \"rfq_description\": \"RFQ for TestingNewEndpoints2\",\n \"item\": [\n {\n \"item_id\": \"44884477-1\",\n \"item_name\": \"Electrician\",\n \"item_quantity\": \"2\",\n \"item_uom\": \"qty\",\n \"item_cost_exc\": \"1000.00\",\n \"item_tax\": \"10.00\",\n \"item_cost_inc\": \"1100.00\",\n \"item_cost_subtotal_exc\": \"2000.00\",\n \"item_cost_subtotal_inc\": \"2200.00\",\n \"item_comment\": \"Comment - rough-in inclusions\"\n },\n {\n \"item_id\": \"44884477-2\",\n \"item_name\": \"Plumber Fit-off\",\n \"item_quantity\": \"3\",\n \"item_uom\": \"qty\",\n \"item_cost_exc\": \"2500.00\",\n \"item_tax\": \"10.00\",\n \"item_cost_inc\": \"2750.00\",\n \"item_cost_subtotal_exc\": \"4500.00\",\n \"item_cost_subtotal_inc\": \"5250.00\",\n \"item_comment\": \"Comment - fitoff inclusions\"\n }\n ]\n }\n ]\n}\n","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/api/rfq/createupdaterfq","description":"When the BuiltGrid network is connected to the project and associated with an RFQ, it should automatically be included as an invited supplier. You can allow it to be removed by the user. RFQ
\nThe RFQ (Request for Quote) posts data to BuiltGrid and, once ingested, is shared with the supplier network for quoting. It works in tandem with the GetJobSuggestions endpoint.
\n\n\n\n| Property name | \nDate type | \nMandatory | \nDefinition | \n
\n\n\n\n| rfq_id | \ncharacter varying | \nY | \nThis is the unique RFQ/cost item ID set by your system. | \n
\n\n| project_id | \ncharacter varying | \nY | \nThis is the unique project_id set by your system. | \n
\n\n| rfq_job_ids | \ncharacter varying | \nY | \nUse the job ids associated with job names selected by the user following get_rfq_job endpoint. Separate ids with commas. | \n
\n\n| rfq_response_date | \ntimestamp with time zone | \n | \nThe expected response date set by the user in your system. | \n
\n\n| rfq_description | \ncharacter varying | \n | \nThe summary description of the RFQ which is shared to trades and suppliers quoting the job. | \n
\n\n| supplier_ids | \ncharacter varying | \n | \nInclude unique supplier IDs added to the RFQ by user, separating IDs with commas. | \n
\n\n| rfq_item_id | \ncharacter varying | \nItem array | \nAll item fields are part of an array. The item ID or SKU (Stock Keeping Unit) as set by the user in your system. | \n
\n\n| rfq_item_name | \ncharacter varying | \nItem array | \nThe characters used in item name, as set by the user in your system. | \n
\n\n| rfq_item_quantity | \nnumeric | \nItem array | \nThe quantity of items, as set by the user in your system. Typically the results of a take off process. | \n
\n\n| rfq_item_uom | \ncharacter varying | \nItem array | \nThe UOM (Unit of Measure) of items, as set by the user in your system. Eg. Each, LM, M2, M3, etc... | \n
\n\n| rfq_item_cost | \nnumeric | \nItem array | \nThe items cost in dollar terms excluding tax, as set by the user in your system. | \n
\n\n| rfq_item_cost_subtotal | \nnumeric | \nItem array | \nThe subtotal is the quantity multiplied by the cost in dollar terms, as set by the user in your system. | \n
\n\n| rfq_item_comment | \ntext | \nItem array | \nThe item-specific comments, as set by the user in your system. | \n
\n\n
\n
Success: Boolean value of TRUE.
Failure: Project not found. Post /api/Project/CreateUpdate, and query endpoint again.
\nRFQ Status
\nWhile the RFQ status is set to 'Pending' at BuiltGrid, the RFQ can be updated using the above endpoint. Check status using GetRFQStatus endpoint. Any other status, besides 'Pending' means the RFQ has already been shared with trades and suppliers and cannot be amended. You may want to consider a 'Save Draft' option on your RFQ page to bypass saving RFQ and job suggestions, and allow a user to return to the RFQ.
\n\nWhen there are suppliers invited into RFQ. Trigger create_contact endpoint after RFQ save for the invited suppliers. This will update the user's supplier contact status to \"favourite\" for your user's account. This means the RFQ bypasses the BuiltGrid jobs board and is added to the supplier's quote board without cost to that supplier. This is important to the builder so they are inclusive in their quoting process.
\n","urlObject":{"path":["api","rfq","createupdaterfq"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"4a7461e1-25b2-4981-9c20-5fb89c5a8e59"},{"name":"Create or update a request for quote V2","id":"5911076f-a339-421f-a5ad-f097048657cf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"data\": [\n {\n \"rfq_id\": \"RFQ-TestingNewEndpoints2\",\n \"project_id\": \"TestingNewEndpoints2\",\n \"rfq_title\": \"Electrician\",\n \"rfq_cost_code_name\": \"\",\n \"rfq_supplier_id\": \"TestingNewEndpoints2\",\n \"rfq_response_date\": \"2024-07-15\",\n \"rfq_description\": \"RFQ for TestingNewEndpoints2\",\n \"item\": [\n {\n \"item_id\": \"44884477-1\",\n \"item_name\": \"Electrician\",\n \"item_quantity\": \"2\",\n \"item_uom\": \"qty\",\n \"item_cost_exc\": \"1000.00\",\n \"item_tax\": \"10.00\",\n \"item_cost_inc\": \"1100.00\",\n \"item_cost_subtotal_exc\": \"2000.00\",\n \"item_cost_subtotal_inc\": \"2200.00\",\n \"item_comment\": \"Comment - rough-in inclusions\"\n },\n {\n \"item_id\": \"44884477-2\",\n \"item_name\": \"Plumber Fit-off\",\n \"item_quantity\": \"3\",\n \"item_uom\": \"qty\",\n \"item_cost_exc\": \"2500.00\",\n \"item_tax\": \"10.00\",\n \"item_cost_inc\": \"2750.00\",\n \"item_cost_subtotal_exc\": \"4500.00\",\n \"item_cost_subtotal_inc\": \"5250.00\",\n \"item_comment\": \"Comment - fitoff inclusions\"\n }\n ]\n }\n ]\n}\n","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/api/rfq/createupdaterfqv2","description":"This endpoint operates in a similar way to the \"Create or update a request for quote\" endpoint. Unlike the previous version, it is not necessary to call the GetJobSuggestions endpoint separately, suggestions are now automatically generated in V2 based on the provided RFQ items.
\nWhen the BuiltGrid network is connected to the project and associated with an RFQ, it should automatically be included as an invited supplier. You can allow it to be removed by the user. RFQ
\nThe RFQ (Request for Quote) posts data to BuiltGrid and, once ingested, is shared with the supplier network for quoting. It works in tandem with the GetJobSuggestions endpoint.
\n\n\n\n| Property name | \nDate type | \nMandatory | \nDefinition | \n
\n\n\n\n| rfq_id | \ncharacter varying | \nY | \nThis is the unique RFQ/cost item ID set by your system. | \n
\n\n| project_id | \ncharacter varying | \nY | \nThis is the unique project_id set by your system. | \n
\n\n| rfq_job_ids | \ncharacter varying | \nY | \nUse the job ids associated with job names selected by the user following get_rfq_job endpoint. Separate ids with commas. | \n
\n\n| rfq_response_date | \ntimestamp with time zone | \n | \nThe expected response date set by the user in your system. | \n
\n\n| rfq_description | \ncharacter varying | \n | \nThe summary description of the RFQ which is shared to trades and suppliers quoting the job. | \n
\n\n| supplier_ids | \ncharacter varying | \n | \nInclude unique supplier IDs added to the RFQ by user, separating IDs with commas. | \n
\n\n| rfq_item_id | \ncharacter varying | \nItem array | \nAll item fields are part of an array. The item ID or SKU (Stock Keeping Unit) as set by the user in your system. | \n
\n\n| rfq_item_name | \ncharacter varying | \nItem array | \nThe characters used in item name, as set by the user in your system. | \n
\n\n| rfq_item_quantity | \nnumeric | \nItem array | \nThe quantity of items, as set by the user in your system. Typically the results of a take off process. | \n
\n\n| rfq_item_uom | \ncharacter varying | \nItem array | \nThe UOM (Unit of Measure) of items, as set by the user in your system. Eg. Each, LM, M2, M3, etc... | \n
\n\n| rfq_item_cost | \nnumeric | \nItem array | \nThe items cost in dollar terms excluding tax, as set by the user in your system. | \n
\n\n| rfq_item_cost_subtotal | \nnumeric | \nItem array | \nThe subtotal is the quantity multiplied by the cost in dollar terms, as set by the user in your system. | \n
\n\n| rfq_item_comment | \ntext | \nItem array | \nThe item-specific comments, as set by the user in your system. | \n
\n\n
\n
Success: Boolean value of TRUE.
Failure: Project not found. Post /api/Project/CreateUpdate, and query endpoint again.
\nRFQ Status
\nWhile the RFQ status is set to 'Pending' at BuiltGrid, the RFQ can be updated using the above endpoint. Check status using GetRFQStatus endpoint. Any other status, besides 'Pending' means the RFQ has already been shared with trades and suppliers and cannot be amended. You may want to consider a 'Save Draft' option on your RFQ page to bypass saving RFQ and job suggestions, and allow a user to return to the RFQ.
\n\nWhen there are suppliers invited into RFQ. Trigger create_contact endpoint after RFQ save for the invited suppliers. This will update the user's supplier contact status to \"favourite\" for your user's account. This means the RFQ bypasses the BuiltGrid jobs board and is added to the supplier's quote board without cost to that supplier. This is important to the builder so they are inclusive in their quoting process.
\n","urlObject":{"path":["api","rfq","createupdaterfqv2"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"5911076f-a339-421f-a5ad-f097048657cf"},{"name":"Retrieve RFQ status","id":"c3f6df6b-d36a-43ba-8d7e-8f4690eedf9e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/api/rfq/GetRFQStatus?bgd_rfq_id=ed04a467-b2f7-4f40-b09c-fc71d80f1779","description":"Refer GetJobSuggestions for an overview of job suggestion endpoints.
\nRFQ statuses at BuiltGrid
\nPending: This status applies anytime before a user saves job selections. In this state, an RFQ can be updated. Any other status won't permit RFQ updates.
\nUpdate: You have posted an RFQ update.
\nUpdated: BuiltGrid has updated internal records after your RFQ update.
\nCreated: The RFQ and job selections have been saved and listed on the job board, available to trades and suppliers to quote.
\n\n\n\n| Property name | \nData type | \nMandatory | \nDefinition | \n
\n\n\n\n| bgd_rfq_id | \ncharacter varying | \nY | \nRFQ endpoint response includes this value. | \n
\n\n
\n
Success: RFQ status
\nFailure: bgd_rfq_id not found
\n","urlObject":{"path":["api","rfq","GetRFQStatus"],"host":["{{base_url}}"],"query":[{"key":"bgd_rfq_id","value":"ed04a467-b2f7-4f40-b09c-fc71d80f1779"}],"variable":[]}},"response":[],"_postman_id":"c3f6df6b-d36a-43ba-8d7e-8f4690eedf9e"},{"name":"Retrieve job suggestions from RFQ content","id":"007cfc77-395a-4601-9ade-4bd2dc1e75cc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/api/rfq/GetRFQSuggestions?bgd_rfq_id=ed04a467-b2f7-4f40-b09c-fc71d80f1779","description":"Overview
\nAfter the user saves an RFQ, it is essential to trigger this endpoint to receive user confirmation of the jobs most closely matched to the RFQ. This is the only task BuiltGrid requires of your user. It is important because the user will multi-select jobs from our supply chain job structure. Doing this achieves the best responses from trades and suppliers. Here's how we suggest you implement the job selection...
\nRequest for Quote (RFQ)
\nPlease trigger the GetJobSuggestions when a user save RFQ. This endpoint retrieves BuiltGrid job suggestions based on RFQ content from 600+ jobs in the supply chain job structure. We suggest the following user experience...
\nUI
\nWe suggest you build a modal to place the job IDs from the GetJobSuggestions endpoint JSON response into a multi-select modal in the order of the json endpoint response.
\n![\"EXAMPLE%20A:%20User%20job%20selection%20modal\"](\"https://content.pstmn.io/3853d7ca-8271-4432-9654-02ea0e553f0f/QnVpbHRHcmlkX0FQSV9QaGFzZTFfMjAyNC1SRlFfSm9ic192My5wbmc=\")
\n\nMaximum rows in UI modal: Please allow up to 20 rows. 90% of responses will be less than five.
\nIn the above example, the jobs selected by the user are saved using StoreJobSuggestions endpoint which should be triggered as part of the modal save process.
\nNo job selections in endpoint response? Although this will be a rare occurrence, we suggest adding an additional modal to allow the user to input a term(s) as a text string.
\n![\"EXAMPLE%20B:%20User%20job%20input\"](\"https://content.pstmn.io/74e65ad9-5eae-4236-b357-ed6898dc871c/QnVpbHRHcmlkX0FQSV9QaGFzZTFfMjAyNF9SRlFfSm9ic19GYWxsYmFjay5wbmc=\")
\n\nAfter the user saves job term(s), add text string to InputGetJobSuggestion endpoint as a parameter. Use the JSON list of job IDs in the endpoint response in the modal shown in example A.
\nRFQ statuses can be checked with GetRFQStatus endpoint.
\n\n\n\n| Property name | \nData type | \nMandatory | \nDefinition | \n
\n\n\n\n| bgd_rfq_id | \ncharacter varying | \nY | \nRFQ endpoint response includes this value. | \n
\n\n
\n
Success: Boolean value of TRUE
\nFailure: bgd_rfq_id not found
\nAPI response example
\nHere's a breakdown of the endpoint JSON response
\n\n\n\n| Property name | \nData type | \nMandatory | \nDefinition | \n
\n\n\n\n| bgd_job_id | \ncharacter varying | \n | \nJob ids from BuiltGrid industry job structure that are suggestions generated from rfq title and items. | \n
\n\n| job_name | \ncharacter varying | \n | \nThe job name associated with the above job id. | \n
\n\n
\n
{\n \"results\": [\n {\n \"data\": [\n {\n \"bgd_job_id\": 500,\n \"job_name\": \"Formwork\"\n },\n {\n \"bgd_job_id\": 501,\n \"job_name\": \"Reinforcing Steel\"\n },\n {\n \"bgd_job_id\": 503,\n \"job_name\": \"Concrete Pumping\"\n },\n ]\n }\n ]\n}\n\n
\n","urlObject":{"path":["api","rfq","GetRFQSuggestions"],"host":["{{base_url}}"],"query":[{"key":"bgd_rfq_id","value":"ed04a467-b2f7-4f40-b09c-fc71d80f1779"}],"variable":[]}},"response":[],"_postman_id":"007cfc77-395a-4601-9ade-4bd2dc1e75cc"},{"name":"Retrieve job suggestions from user input","id":"aae696e2-c6d8-412a-ab34-b148ca6c65e2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/api/rfq/InputGetJobSuggestion?bgd_rfq_id=b7cdd6d7-1689-4b88-aed9-9d5c3a9910f5&job_search=Electrician","description":"Refer GetJobSuggestions for an overview of job suggestion endpoints.
\n\n\n\n| Property name | \nData type | \nMandatory | \nDefinition | \n
\n\n\n\n| bgd_rfq_id | \ncharacter varying | \nY | \nRFQ endpoint response includes this value. | \n
\n\n
\n
Success: Boolean value of TRUE
\nFailure: bgd_rfq_id not found
\nAPI response example
\nHere's a breakdown of the endpoint JSON response
\n\n\n\n| Property name | \nData type | \nMandatory | \nDefinition | \n
\n\n\n\n| bgd_job_id | \ncharacter varying | \n | \nJob ids from BuiltGrid industry job structure that are suggestions generated from rfq title and items. | \n
\n\n| job_name | \ncharacter varying | \n | \nThe job name associated with the above job id. | \n
\n\n
\n
{\n \"results\": [\n {\n \"data\": [\n {\n \"bgd_job_id\": 500,\n \"job_name\": \"Formwork\"\n },\n {\n \"bgd_job_id\": 501,\n \"job_name\": \"Reinforcing Steel\"\n },\n {\n \"bgd_job_id\": 503,\n \"job_name\": \"Concrete Pumping\"\n },\n ]\n }\n ]\n}\n\n
\n","urlObject":{"path":["api","rfq","InputGetJobSuggestion"],"host":["{{base_url}}"],"query":[{"key":"bgd_rfq_id","value":"b7cdd6d7-1689-4b88-aed9-9d5c3a9910f5"},{"key":"job_search","value":"Electrician"}],"variable":[]}},"response":[],"_postman_id":"aae696e2-c6d8-412a-ab34-b148ca6c65e2"},{"name":"Create job suggestions in RFQ","id":"f56fe10d-98f6-44ca-9205-54542dfc3566","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"data\": [\n {\n \"bgd_rfq_id\": \"e345780b-a275-4c8a-82f5-fdf03ec2b608\",\n \"selected_bgd_job_id\": \"445,298,59,60\" \n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/api/rfq/StoreRFQSuggestions","description":"This endpoint will save user job selections to an RFQ at BuiltGrid.
\nRefer GetJobSuggestions for an overview of job suggestion endpoints.
\n\n\n\n| Property name | \nData type | \nMandatory | \nDefinition | \n
\n\n\n\n| rfq_id | \ncharacter varying | \nY | \nThis is the unique RFQ ID set by your system. | \n
\n\n| selected_bgd_job_id | \ncharacter varying | \nY | \nPlease add each job id selected by user, separated by comma. | \n
\n\n
\n
IMPORTANT: Only use this endpoint once per RFQ id.
\nSuccess: Boolean value of TRUE
\nFailure: Failure: Errors include \"RFQ not found\", \"No Job ID\" or \"RFQ already has Job IDs.\" The multi-select checklist UI component in your app should be mandatory so Job IDs are always selected, including where the user has chosen to skip.
\n","urlObject":{"path":["api","rfq","StoreRFQSuggestions"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"f56fe10d-98f6-44ca-9205-54542dfc3566"}],"id":"38978895-b275-46c2-a5bf-b33d3b54e231","description":"The RFQ (Request for Quote) posts data to BuiltGrid and is shared with the supplier network to generate quotes for your user's projects/jobs. Please read about the job ID cycle which is associated with RFQs in the GetJobSuggestions section.
\nNote: If you don't have users making BuiltGrid job selections in your app, you can skip the endpoints related to job suggestions.
\n","_postman_id":"38978895-b275-46c2-a5bf-b33d3b54e231","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"5bc456b8-aae3-4110-812d-6b125b35bbb2","id":"5bc456b8-aae3-4110-812d-6b125b35bbb2","name":"BuiltGrid - Builder Apps","type":"collection"}}},{"name":"Quote","item":[{"name":"Create or update a quote","id":"1e584f70-e075-4d51-9976-cf8c1959f370","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"data\": [\n {\n \"quote_id\": \"Quote-TestingNewEndpoints\", \n \"rfq_id\": \"RFQ-TestingNewEndpoints\",\n \"supplier_id\": \"TestingNewEndpoints2\",\n \"supplier_trading_name\": \"TestingNewEndpoints2\",\n \"quote_date\": \"2024-08-21\",\n \"quote_reference\": \"quote_viaapi\",\n \"total_cost_exc\": \"5400.00\",\n \"total_tax\": \"540.00\",\n \"total_cost_inc\": \"5400.00\",\n \"delivery_included\": \"true\",\n \"terms\": \"Added via API\",\n \"comment\": \"Added via API\",\n \"quote_expiry_date\": \"2024-08-21\",\n \"warranty\": \"Added via API\",\n \"service_features\": \"Added via API\",\n \"value_proposition\": \"Added via API\",\n \"exclusions\": \"Added via API\",\n \"source\": \"source\",\n \"environmental_benefit\": \"environmental_benefit\",\n \"payment_type_account\": \"payment_type_account\",\n \"payment_type_payments\": \"payment_type_payments\",\n \"payments_stage1\": \"payments_stage1\",\n \"payments_stage1_percent\": \"10\",\n \"payments_stage1_days\": \"payments_stage1_days\",\n \"payments_stage1_event\": \"payments_stage1_event\",\n \"payments_stage2\": \"payments_stage2\",\n \"payments_stage2_percent\": \"10\",\n \"payments_stage2_days\": \"payments_stage2_days\",\n \"payments_stage2_event\": \"payments_stage2_event\",\n \"payments_stage3\": \"payments_stage3\",\n \"payments_stage3_percent\": \"10\",\n \"payments_stage3_days\": \"payments_stage3_days\",\n \"payments_stage3_event\": \"payments_stage3_event\",\n \"payments_stage4\": \"payments_stage4\",\n \"payments_stage4_percent\": \"10\",\n \"payments_stage4_days\": \"payments_stage4_days\",\n \"payments_stage4_event\": \"payments_stage4_event\",\n \"item\":[{\n \"quote_item_id\": \"200\",\n \"quote_item_name\": \"Item Name\",\n \"quote_item_quantity\": \"200\",\n \"quote_item_uom\": \"m2\",\n \"quote_item_cost_exc\": \"1200.00\",\n \"quote_item_tax\": \"1200.00\",\n \"quote_item_cost_subtotal_exc\": \"1200.00\",\n \"quote_item_cost_subtotal_inc\": \"1320.00\",\n \"quote_item_cost_inc\": \"1500.00\",\n \"quote_item_comment\": \"Comment\"\n },\n {\n \"quote_item_id\": \"300\",\n \"quote_item_name\": \"Item Name\",\n \"quote_item_quantity\": \"300\",\n \"quote_item_uom\": \"m2\",\n \"quote_item_cost_exc\": \"1300.00\",\n \"quote_item_tax\": \"1300.00\",\n \"quote_item_cost_subtotal_exc\": \"1350.00\",\n \"quote_item_cost_subtotal_inc\": \"1320.00\",\n \"quote_item_cost_inc\": \"1000\",\n \"quote_item_comment\": \"Comment\"\n }\n ]\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/api/quote/createupdatequote","description":"This endpoint shares quote data from your system with the BuiltGrid system.
\npost_create_update_quote field definitions are as follows:
\n\n\n\n| Property name | \nDate type | \nMandatory | \nDefinition | \n
\n\n\n\n| quote_id | \ncharacter varying | \nY | \nThis is the unique quote ID set by your system. | \n
\n\n| rfq_id | \ncharacter varying | \nY | \nThis is the unique RFQ ID set by your system. | \n
\n\n| supplier_id | \ncharacter varying | \nY | \nThis is the unique supplier_id set by your system. | \n
\n\n| supplier_trading_name | \ncharacter varying | \n | \nThis is the supplier business name as set by customer in your system. | \n
\n\n| quote_date | \ntimestamp with time zone | \nY | \nThe creation date of the quote as set by the supplier in their system. | \n
\n\n| quote_reference | \ncharacter varying | \nY | \nThe id of the quote as set by the supplier in their system. | \n
\n\n| total_cost_exc | \nnumeric | \nY | \nThe grand total of all items subtotals excluding tax in dollar terms, as set by the supplier in their system. | \n
\n\n| total_tax | \nnumeric | \nY | \nThe grand total of all items subtotals tax amount in dollar terms, as set by the supplier in their system. | \n
\n\n| total_cost_inc | \nnumeric | \nY | \nThe grand total of all items subtotals including tax in dollar terms, as set by the supplier in their system. | \n
\n\n| delivery_included | \ncharacter varying | \n | \nA flag to indicate if the quote includes or excludes delivery fee. Typically true or false as set by the supplier in their system. | \n
\n\n| terms | \ncharacter varying | \n | \nThe summary payment terms associated with the quote as set by the supplier in their system. Limited to 25 characters. | \n
\n\n| comment | \ntext | \n | \nThe summary comment of the quote as set by the supplier in their system. | \n
\n\n| quote_expiry_date | \ntime stamp with time zone | \n | \nThe expiry date of the quote as set by the supplier in their system. | \n
\n\n| warranty | \ncharacter varying | \n | \nOptional field describing job warranty benefits and conditions. | \n
\n\n| service_features | \ncharacter varying | \n | \nOptional field describing unique job features which may include selection centre, mobile selection, shopfront, displays, samples, design, take-off. | \n
\n\n| value_proposition | \ncharacter varying | \n | \nOptional field describing unique market positioning of the supplier submitting the quote. | \n
\n\n| exclusions | \ncharacter varying | \n | \nOptional field describing any exclusions the supplier wishes to state. | \n
\n\n| source | \ncharacter varying | \n | \nOptional field describing the source of the materials in the quote. Choices are \"Local\" or \"Imported\". | \n
\n\n| environmental_benefit | \ncharacter varying | \n | \nOptional field describing environmental benefit in terms of a number - tonnes | \n
\n\n| payment_type_account | \ncharacter varying | \n | \nState whether the payment would be on a credit account. Stated as TRUE or FALSE. | \n
\n\n| payment_type_payments | \ncharacter varying | \n | \nState whether the payment would be made in an alternative to credit, like EFT, cash, etc.. Stated as TRUE or FALSE. | \n
\n\n| payments_stage1_event | \ncharacter varying | \n | \nThis is the first payment descriptor, using one of the following: Deposit, Payment or Balance. | \n
\n\n| payments_stage1 | \nnumeric | \n | \nFirst payment expressed as a percentage, from 0.00% to 100.00%. | \n
\n\n| payments_stage1_percent | \ncharacter varying | \n | \nNumber of days from event (next field) the payment is due. | \n
\n\n| payments_stage1_days | \ncharacter varying | \n | \nThe event that triggers numbers of days payment is due, with the following choices: Before job starts, After delivery of goods, After job start, After agreed job milestone, After job finish. | \n
\n\n| payments_stage2 | \ncharacter varying | \n | \nThis is the second payment descriptor, using one of the following: Deposit, Payment or Balance. | \n
\n\n| payments_stage2_percent | \nnumeric | \n | \nSecond payment expressed as a percentage, from 0.00% to 100.00%. | \n
\n\n| payments_stage2_days | \ncharacter varying | \n | \nNumber of days from event (next field) the payment is due. | \n
\n\n| payments_stage2_event | \ncharacter varying | \n | \nThe event that triggers numbers of days payment is due, with the following choices: Before job starts, After delivery of goods, After job start, After agreed job milestone, After job finish. | \n
\n\n| payments_stage3 | \ncharacter varying | \n | \nThis is the third payment descriptor, using one of the following: Deposit, Payment or Balance. | \n
\n\n| payments_stage3_percent | \nnumeric | \n | \nThird payment expressed as a percentage, from 0.00% to 100.00%. | \n
\n\n| payments_stage3_days | \ncharacter varying | \n | \nNumber of days from event (next field) the payment is due. | \n
\n\n| payments_stage3_event | \ncharacter varying | \n | \nThe event that triggers numbers of days payment is due, with the following choices: Before job starts, After delivery of goods, After job start, After agreed job milestone, After job finish. | \n
\n\n| payments_stage4 | \ncharacter varying | \n | \nThis is the fourth payment descriptor, using one of the following: Deposit, Payment or Balance. | \n
\n\n| payments_stage4_percent | \nnumeric | \n | \nFourth payment expressed as a percentage, from 0.00% to 100.00%. | \n
\n\n| payments_stage4_days | \ncharacter varying | \n | \nNumber of days from event (next field) the payment is due. | \n
\n\n| payments_stage4_event | \ncharacter varying | \n | \nThe event that triggers numbers of days payment is due, with the following choices: Before job starts, After delivery of goods, After job start, After agreed job milestone, After job finish. | \n
\n\n| quote_item_id | \ncharacter varying | \nItem array | \nAll item fields are part of an array. The item ID or SKU (Stock Keeping Unit) as set by the supplier in their system. | \n
\n\n| quote_item_name | \ncharacter varying | \nItem array | \nThe characters used in item name, as set by the supplier in their system. | \n
\n\n| quote_item_quantity | \ninteger | \nItem array | \nThe quantity of items, as set by the supplier in their system. | \n
\n\n| quote_item_uom | \ncharacter varying | \nItem array | \nThe UOM (Unit of Measure) of items, as set by the supplier in their system. Eg. Each, LM, M2, M3, etc... | \n
\n\n| quote_item_cost_exc | \nnumeric | \nItem array | \nThe item cost excluding tax in dollar terms, as set by the supplier in their system. | \n
\n\n| quote_item_tax | \nnumeric | \nItem array | \nThe item tax amount in dollar terms, as set by the supplier in their system. | \n
\n\n| quote_item_cost_inc | \nnumeric | \nItem array | \nThe item cost including tax in dollar terms, as set by the supplier in their system. | \n
\n\n| quote_item_cost_subtotal_exc | \nnumeric | \nItem array | \nThe subtotal is the quantity multiplied by the cost excluding tax in dollar terms, as set by the supplier in their system. | \n
\n\n| quote_item_cost_subtotal_inc | \nnumeric | \nItem array | \nThe subtotal is the quantity multiplied by the cost including tax in dollar terms, as set by the supplier in their system. | \n
\n\n| quote_item_comment | \ntext | \nItem array | \nThe item-specific comments, as set by the supplier in their system. | \n
\n\n
\n
Success: Boolean value of TRUE.
Failure: POST: quote_id not found.
\n","urlObject":{"path":["api","quote","createupdatequote"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"1e584f70-e075-4d51-9976-cf8c1959f370"},{"name":"Create or update a quote V2","id":"0e44ecbd-91ea-4bf1-826a-9b9b3e29d63f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"data\": [\n {\n \"quote_id\": \"Quote-TestingNewEndpoints\", \n \"rfq_id\": \"RFQ-TestingNewEndpoints\",\n \"supplier_id\": \"TestingNewEndpoints2\",\n \"supplier_trading_name\": \"TestingNewEndpoints2\",\n \"quote_date\": \"2024-08-21\",\n \"quote_reference\": \"quote_viaapi\",\n \"total_cost_exc\": \"5400.00\",\n \"total_tax\": \"540.00\",\n \"total_cost_inc\": \"5400.00\",\n \"delivery_included\": \"true\",\n \"terms\": \"Added via API\",\n \"comment\": \"Added via API\",\n \"quote_expiry_date\": \"2024-08-21\",\n \"warranty\": \"Added via API\",\n \"service_features\": \"Added via API\",\n \"value_proposition\": \"Added via API\",\n \"exclusions\": \"Added via API\",\n \"source\": \"source\",\n \"environmental_benefit\": \"environmental_benefit\",\n \"payment_type_account\": \"payment_type_account\",\n \"payment_type_payments\": \"payment_type_payments\",\n \"payments_stage1\": \"payments_stage1\",\n \"payments_stage1_percent\": \"10\",\n \"payments_stage1_days\": \"payments_stage1_days\",\n \"payments_stage1_event\": \"payments_stage1_event\",\n \"payments_stage2\": \"payments_stage2\",\n \"payments_stage2_percent\": \"10\",\n \"payments_stage2_days\": \"payments_stage2_days\",\n \"payments_stage2_event\": \"payments_stage2_event\",\n \"payments_stage3\": \"payments_stage3\",\n \"payments_stage3_percent\": \"10\",\n \"payments_stage3_days\": \"payments_stage3_days\",\n \"payments_stage3_event\": \"payments_stage3_event\",\n \"payments_stage4\": \"payments_stage4\",\n \"payments_stage4_percent\": \"10\",\n \"payments_stage4_days\": \"payments_stage4_days\",\n \"payments_stage4_event\": \"payments_stage4_event\",\n \"item\":[{\n \"quote_item_id\": \"200\",\n \"quote_item_name\": \"Item Name\",\n \"quote_item_quantity\": \"200\",\n \"quote_item_uom\": \"m2\",\n \"quote_item_cost_exc\": \"1200.00\",\n \"quote_item_tax\": \"1200.00\",\n \"quote_item_cost_subtotal_exc\": \"1200.00\",\n \"quote_item_cost_subtotal_inc\": \"1320.00\",\n \"quote_item_cost_inc\": \"1500.00\",\n \"quote_item_comment\": \"Comment\"\n },\n {\n \"quote_item_id\": \"300\",\n \"quote_item_name\": \"Item Name\",\n \"quote_item_quantity\": \"300\",\n \"quote_item_uom\": \"m2\",\n \"quote_item_cost_exc\": \"1300.00\",\n \"quote_item_tax\": \"1300.00\",\n \"quote_item_cost_subtotal_exc\": \"1350.00\",\n \"quote_item_cost_subtotal_inc\": \"1320.00\",\n \"quote_item_cost_inc\": \"1000\",\n \"quote_item_comment\": \"Comment\"\n }\n ]\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/api/quote/createupdatequotev2","description":"This endpoint is intended for creating a quote in BGD when the associated RFQ was created (or updated) via the Create or update a request for quote V2 endpoint.
\nThis endpoint shares quote data from your system with the BuiltGrid system.
\npost_create_update_quote field definitions are as follows:
\n\n\n\n| Property name | \nDate type | \nMandatory | \nDefinition | \n
\n\n\n\n| quote_id | \ncharacter varying | \nY | \nThis is the unique quote ID set by your system. | \n
\n\n| rfq_id | \ncharacter varying | \nY | \nThis is the unique RFQ ID set by your system. | \n
\n\n| supplier_id | \ncharacter varying | \nY | \nThis is the unique supplier_id set by your system. | \n
\n\n| supplier_trading_name | \ncharacter varying | \n | \nThis is the supplier business name as set by customer in your system. | \n
\n\n| quote_date | \ntimestamp with time zone | \nY | \nThe creation date of the quote as set by the supplier in their system. | \n
\n\n| quote_reference | \ncharacter varying | \nY | \nThe id of the quote as set by the supplier in their system. | \n
\n\n| total_cost_exc | \nnumeric | \nY | \nThe grand total of all items subtotals excluding tax in dollar terms, as set by the supplier in their system. | \n
\n\n| total_tax | \nnumeric | \nY | \nThe grand total of all items subtotals tax amount in dollar terms, as set by the supplier in their system. | \n
\n\n| total_cost_inc | \nnumeric | \nY | \nThe grand total of all items subtotals including tax in dollar terms, as set by the supplier in their system. | \n
\n\n| delivery_included | \ncharacter varying | \n | \nA flag to indicate if the quote includes or excludes delivery fee. Typically true or false as set by the supplier in their system. | \n
\n\n| terms | \ncharacter varying | \n | \nThe summary payment terms associated with the quote as set by the supplier in their system. Limited to 25 characters. | \n
\n\n| comment | \ntext | \n | \nThe summary comment of the quote as set by the supplier in their system. | \n
\n\n| quote_expiry_date | \ntime stamp with time zone | \n | \nThe expiry date of the quote as set by the supplier in their system. | \n
\n\n| warranty | \ncharacter varying | \n | \nOptional field describing job warranty benefits and conditions. | \n
\n\n| service_features | \ncharacter varying | \n | \nOptional field describing unique job features which may include selection centre, mobile selection, shopfront, displays, samples, design, take-off. | \n
\n\n| value_proposition | \ncharacter varying | \n | \nOptional field describing unique market positioning of the supplier submitting the quote. | \n
\n\n| exclusions | \ncharacter varying | \n | \nOptional field describing any exclusions the supplier wishes to state. | \n
\n\n| source | \ncharacter varying | \n | \nOptional field describing the source of the materials in the quote. Choices are \"Local\" or \"Imported\". | \n
\n\n| environmental_benefit | \ncharacter varying | \n | \nOptional field describing environmental benefit in terms of a number - tonnes | \n
\n\n| payment_type_account | \ncharacter varying | \n | \nState whether the payment would be on a credit account. Stated as TRUE or FALSE. | \n
\n\n| payment_type_payments | \ncharacter varying | \n | \nState whether the payment would be made in an alternative to credit, like EFT, cash, etc.. Stated as TRUE or FALSE. | \n
\n\n| payments_stage1_event | \ncharacter varying | \n | \nThis is the first payment descriptor, using one of the following: Deposit, Payment or Balance. | \n
\n\n| payments_stage1 | \nnumeric | \n | \nFirst payment expressed as a percentage, from 0.00% to 100.00%. | \n
\n\n| payments_stage1_percent | \ncharacter varying | \n | \nNumber of days from event (next field) the payment is due. | \n
\n\n| payments_stage1_days | \ncharacter varying | \n | \nThe event that triggers numbers of days payment is due, with the following choices: Before job starts, After delivery of goods, After job start, After agreed job milestone, After job finish. | \n
\n\n| payments_stage2 | \ncharacter varying | \n | \nThis is the second payment descriptor, using one of the following: Deposit, Payment or Balance. | \n
\n\n| payments_stage2_percent | \nnumeric | \n | \nSecond payment expressed as a percentage, from 0.00% to 100.00%. | \n
\n\n| payments_stage2_days | \ncharacter varying | \n | \nNumber of days from event (next field) the payment is due. | \n
\n\n| payments_stage2_event | \ncharacter varying | \n | \nThe event that triggers numbers of days payment is due, with the following choices: Before job starts, After delivery of goods, After job start, After agreed job milestone, After job finish. | \n
\n\n| payments_stage3 | \ncharacter varying | \n | \nThis is the third payment descriptor, using one of the following: Deposit, Payment or Balance. | \n
\n\n| payments_stage3_percent | \nnumeric | \n | \nThird payment expressed as a percentage, from 0.00% to 100.00%. | \n
\n\n| payments_stage3_days | \ncharacter varying | \n | \nNumber of days from event (next field) the payment is due. | \n
\n\n| payments_stage3_event | \ncharacter varying | \n | \nThe event that triggers numbers of days payment is due, with the following choices: Before job starts, After delivery of goods, After job start, After agreed job milestone, After job finish. | \n
\n\n| payments_stage4 | \ncharacter varying | \n | \nThis is the fourth payment descriptor, using one of the following: Deposit, Payment or Balance. | \n
\n\n| payments_stage4_percent | \nnumeric | \n | \nFourth payment expressed as a percentage, from 0.00% to 100.00%. | \n
\n\n| payments_stage4_days | \ncharacter varying | \n | \nNumber of days from event (next field) the payment is due. | \n
\n\n| payments_stage4_event | \ncharacter varying | \n | \nThe event that triggers numbers of days payment is due, with the following choices: Before job starts, After delivery of goods, After job start, After agreed job milestone, After job finish. | \n
\n\n| quote_item_id | \ncharacter varying | \nItem array | \nAll item fields are part of an array. The item ID or SKU (Stock Keeping Unit) as set by the supplier in their system. | \n
\n\n| quote_item_name | \ncharacter varying | \nItem array | \nThe characters used in item name, as set by the supplier in their system. | \n
\n\n| quote_item_quantity | \ninteger | \nItem array | \nThe quantity of items, as set by the supplier in their system. | \n
\n\n| quote_item_uom | \ncharacter varying | \nItem array | \nThe UOM (Unit of Measure) of items, as set by the supplier in their system. Eg. Each, LM, M2, M3, etc... | \n
\n\n| quote_item_cost_exc | \nnumeric | \nItem array | \nThe item cost excluding tax in dollar terms, as set by the supplier in their system. | \n
\n\n| quote_item_tax | \nnumeric | \nItem array | \nThe item tax amount in dollar terms, as set by the supplier in their system. | \n
\n\n| quote_item_cost_inc | \nnumeric | \nItem array | \nThe item cost including tax in dollar terms, as set by the supplier in their system. | \n
\n\n| quote_item_cost_subtotal_exc | \nnumeric | \nItem array | \nThe subtotal is the quantity multiplied by the cost excluding tax in dollar terms, as set by the supplier in their system. | \n
\n\n| quote_item_cost_subtotal_inc | \nnumeric | \nItem array | \nThe subtotal is the quantity multiplied by the cost including tax in dollar terms, as set by the supplier in their system. | \n
\n\n| quote_item_comment | \ntext | \nItem array | \nThe item-specific comments, as set by the supplier in their system. | \n
\n\n
\n
Success: Boolean value of TRUE.
Failure: POST: quote_id not found.
\n","urlObject":{"path":["api","quote","createupdatequotev2"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"0e44ecbd-91ea-4bf1-826a-9b9b3e29d63f"},{"name":"Create or update a quote document","id":"d8ff169f-5c2e-46cf-9378-3bf4d2b51951","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"api-key","value":"a3a950f2-f8bb-4216-9c7f-7be422ad87c1"}],"body":{"mode":"raw","raw":"{\n \"data\": [\n {\n \"quote_doc_id\": \"Doc-TestingNewEndpoints\",\n \"quote_id\": \"Quote-TestingNewEndpoints\",\n \"quote_doc_name\": \"sample.pdf\",\n \"quote_doc_type\": \"Quote\",\n \"quote_doc_url\": \"https://pdfobject.com/pdf/sample.pdf\",\n \"quote_doc_extension\": \"application/pdf\"\n }\n\n \n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/api/quote/document","description":"This endpoint shares quote docs from your system with the BuiltGrid system, linked by quote_id.
\nquote_document field definitions are as follows:
\n\n\n\n| Property name | \nDate type | \nMandatory | \nDefinition | \n
\n\n\n\n| quote_doc_id | \ncharacter varying | \nY | \nThis is the unique quote_doc_id set by your system and associated with the document. | \n
\n\n| quote_id | \ncharacter varying | \nY | \nThis is the unique quote_id set by your system and associated with the document. | \n
\n\n| quote_doc_name | \ncharacter varying | \n | \nThis is the quote_doc_name set by the supplier for the document in your system. Maximum character length is 255. | \n
\n\n| quote_doc_type | \ncharacter varying | \n | \nThis is the quote_doc_type set by your system. This could be a 'quote' or 'supporting' document. | \n
\n\n| quote_doc_url | \ncharacter varying | \n | \nProvide a url that provides partner access to the file. | \n
\n\n| quote_doc_extension | \ncharacter varying | \n | \nThe 3-4 character file extension refers to a file type. The following document types can be uploaded, up to 50Mb:
application/pdf
image/jpeg
image/jpg
image/png
application/vnd.ms-excel
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
application/msword
application/vnd.openxmlformats-officedocument.wordprocessingml.document | \n
\n\n
\n
Success: Boolean value of TRUE.
Failure: quote_id not found.
\n","urlObject":{"path":["api","quote","document"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"d8ff169f-5c2e-46cf-9378-3bf4d2b51951"},{"name":"Retrieve quote using your system quote ID","id":"4cc758cf-a163-4958-ba84-71fe9c291006","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/api/quote/GetQuoteByID?bgd_rfq_id=ed04a467-b2f7-4f40-b09c-fc71d80f1779"e_id=Quote-TestingNewEndpoints","description":"\n\n\n| Property name | \nData type | \nMandatory | \nDefinition | \n
\n\n\n\n| quote_id | \ncharacter varying | \nY | \nThis is the unique quote ID set by your system. | \n
\n\n
\n
Success: Boolean value of TRUE
\nFailure: quote_id not found
\nAPI response example
\nHere's a breakdown of the endpoint JSON response.
\n{\n \"results\": [\n {\n \"response\": [\n {\n \"quote_id\": \"Quote-TestingNewEndpoints\",\n \"rfq_id\": \"ed04a467-b2f7-4f40-b09c-fc71d80f1779\",\n \"supplier_trading_name\": \"TestingNewEndpoints2\",\n \"total_cost_exc\": \"4,909.09\",\n \"total_tax\": \"490.91\",\n \"total_cost_inc\": \"5,400.00\",\n \"gst\": \"Including GST\",\n \"delivery_included\": true,\n \"quote_reference\": \"quote_viaapi\",\n \"account\": true,\n \"payments\": true,\n \"warranty\": \"Added via API\",\n \"services\": \"Added via API\",\n \"value_proposition\": \"Added via API\",\n \"exclusions\": \"Added via API\",\n \"source\": \"source\",\n \"comment\": \"comment\",\n \"stage1\": \"payments_stage1\",\n \"stage1_percent\": \"10\",\n \"stage1_days\": \"payments_stage1_days\",\n \"stage1_event\": \"payments_stage1_event\",\n \"stage2\": \"payments_stage2\",\n \"stage2_percent\": \"10\",\n \"stage2_days\": \"payments_stage2_days\",\n \"stage2_event\": \"payments_stage2_event\",\n \"stage3\": \"payments_stage3\",\n \"stage3_percent\": \"10\",\n \"stage3_days\": \"payments_stage3_days\",\n \"stage3_event\": \"payments_stage3_event\",\n \"stage4\": \"payments_stage4\",\n \"stage4_percent\": \"10\",\n \"stage4_days\": \"payments_stage4_days\",\n \"stage4_event\": \"payments_stage4_event\",\n \"created_at\": \"2025-02-26T20:21:14.000Z\"\n }\n ]\n }\n ]\n}\n\n
\n","urlObject":{"path":["api","quote","GetQuoteByID"],"host":["{{base_url}}"],"query":[{"key":"bgd_rfq_id","value":"ed04a467-b2f7-4f40-b09c-fc71d80f1779"},{"key":"quote_id","value":"Quote-TestingNewEndpoints"}],"variable":[]}},"response":[],"_postman_id":"4cc758cf-a163-4958-ba84-71fe9c291006"},{"name":"Retrieve quote using BuiltGrid RFQ ID","id":"b3f5e0ac-a718-4589-9669-f01634508790","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/api/quote/GetQuoteByRFQ?bgd_rfq_id=ed04a467-b2f7-4f40-b09c-fc71d80f1779","description":"\n\n\n| Property name | \nData type | \nMandatory | \nDefinition | \n
\n\n\n\n| bgd_rfq_id | \ncharacter varying | \nY | \nThis is the value shared in the RFQ endpoint response. | \n
\n\n
\n
Success: Boolean value of TRUE
\nFailure: bgd_rfq_id not found
\nAPI response example
\nHere's a breakdown of the endpoint JSON response.
\n{\n \"results\": [\n {\n \"response\": [\n {\n \"quote_id\": \"Quote-TestingNewEndpoints\",\n \"rfq_id\": \"ed04a467-b2f7-4f40-b09c-fc71d80f1779\",\n \"supplier_trading_name\": \"TestingNewEndpoints2\",\n \"total_cost_exc\": \"4,909.09\",\n \"total_tax\": \"490.91\",\n \"total_cost_inc\": \"5,400.00\",\n \"gst\": \"Including GST\",\n \"delivery_included\": true,\n \"quote_reference\": \"quote_viaapi\",\n \"account\": true,\n \"payments\": true,\n \"warranty\": \"Added via API\",\n \"services\": \"Added via API\",\n \"value_proposition\": \"Added via API\",\n \"exclusions\": \"Added via API\",\n \"source\": \"source\",\n \"comment\": \"comment\",\n \"stage1\": \"payments_stage1\",\n \"stage1_percent\": \"10\",\n \"stage1_days\": \"payments_stage1_days\",\n \"stage1_event\": \"payments_stage1_event\",\n \"stage2\": \"payments_stage2\",\n \"stage2_percent\": \"10\",\n \"stage2_days\": \"payments_stage2_days\",\n \"stage2_event\": \"payments_stage2_event\",\n \"stage3\": \"payments_stage3\",\n \"stage3_percent\": \"10\",\n \"stage3_days\": \"payments_stage3_days\",\n \"stage3_event\": \"payments_stage3_event\",\n \"stage4\": \"payments_stage4\",\n \"stage4_percent\": \"10\",\n \"stage4_days\": \"payments_stage4_days\",\n \"stage4_event\": \"payments_stage4_event\",\n \"created_at\": \"2025-02-26T20:21:14.000Z\"\n }\n ]\n }\n ]\n}\n\n
\n","urlObject":{"path":["api","quote","GetQuoteByRFQ"],"host":["{{base_url}}"],"query":[{"key":"bgd_rfq_id","value":"ed04a467-b2f7-4f40-b09c-fc71d80f1779"}],"variable":[]}},"response":[],"_postman_id":"b3f5e0ac-a718-4589-9669-f01634508790"},{"name":"Retrieve quote document using your system quote ID","id":"51a001ec-1e43-40b0-8a18-c740ee147fe2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/api/quote/GetQuoteDocByID?bgd_rfq_id=ed04a467-b2f7-4f40-b09c-fc71d80f1779"e_id=Quote-TestingNewEndpoints","description":"\n\n\n| Property name | \nData type | \nMandatory | \nDefinition | \n
\n\n\n\n| quote_id | \ncharacter varying | \nY | \nThis is the unique quote ID set by your system. | \n
\n\n
\n
Success: Boolean value of TRUE
\nFailure: quote_id not found
\nAPI response example
\nHere's a breakdown of the endpoint JSON response. When testing, please replace domain with staging IP address. We need to create quotes for you to test this element to simulate supplier quote responses. Just send us a request by Slack or email.
\n{\n \"results\": [\n {\n \"response\": [\n {\n \"quote_id\": \"Quote-TestingNewEndpoints\",\n \"RFQ_id\": \"RFQ-TestingNewEndpoints\",\n \"quote_doc_id\": \"Doc-TestingNewEndpoints\",\n \"doc_name\": \"sample.pdf\",\n \"doc_type\": \"Quote\",\n \"doc_link\": \"https://webappdocs.sgp1.digitaloceanspaces.com/project_docs/quotes/42f95304-37c7-4b98-9d24-c792200349b5/sample.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Credential=DO00NVV4DQ8CWHNQKKD4/20250226/us-east-1/s3/aws4_request&X-Amz-Date=20250226T202605Z&X-Amz-Expires=172800&X-Amz-Signature=d4e98dea613b6d64770bdef95cb21e6a603b7fe514d32d1307bb719d1775cf3f&X-Amz-SignedHeaders=host&x-amz-checksum-mode=ENABLED&x-id=GetObject\"\n }\n ]\n }\n ]\n}\n\n\n
\n","urlObject":{"path":["api","quote","GetQuoteDocByID"],"host":["{{base_url}}"],"query":[{"key":"bgd_rfq_id","value":"ed04a467-b2f7-4f40-b09c-fc71d80f1779"},{"key":"quote_id","value":"Quote-TestingNewEndpoints"}],"variable":[]}},"response":[],"_postman_id":"51a001ec-1e43-40b0-8a18-c740ee147fe2"},{"name":"Retrieve quote document using BuiltGrid RFQ ID","id":"f511a4e2-4ede-4e97-9284-c62c0db50ed9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/api/quote/GetQuoteDocByRFQ?bgd_rfq_id=ed04a467-b2f7-4f40-b09c-fc71d80f1779"e_id=Quote-TestingNewEndpoints","description":"\n\n\n| Property name | \nData type | \nMandatory | \nDefinition | \n
\n\n\n\n| bgd_rfq_id | \ncharacter varying | \nY | \nThis is the value shared in RFQ endpoint response. | \n
\n\n
\n
Success: Boolean value of TRUE
\nFailure: bgd_rfq_id not found
\nAPI response example
\nHere's a breakdown of the endpoint JSON response.
\n{\n \"results\": [\n {\n \"response\": [\n {\n \"quote_id\": \"Quote-TestingNewEndpoints\",\n \"RFQ_id\": \"RFQ-TestingNewEndpoints\",\n \"quote_doc_id\": \"Doc-TestingNewEndpoints\",\n \"doc_name\": \"sample.pdf\",\n \"doc_type\": \"Quote\",\n \"doc_link\": \"https://webappdocs.sgp1.digitaloceanspaces.com/project_docs/quotes/42f95304-37c7-4b98-9d24-c792200349b5/sample.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Credential=DO00NVV4DQ8CWHNQKKD4/20250226/us-east-1/s3/aws4_request&X-Amz-Date=20250226T202605Z&X-Amz-Expires=172800&X-Amz-Signature=d4e98dea613b6d64770bdef95cb21e6a603b7fe514d32d1307bb719d1775cf3f&X-Amz-SignedHeaders=host&x-amz-checksum-mode=ENABLED&x-id=GetObject\"\n }\n ]\n }\n ]\n}\n\n
\n","urlObject":{"path":["api","quote","GetQuoteDocByRFQ"],"host":["{{base_url}}"],"query":[{"key":"bgd_rfq_id","value":"ed04a467-b2f7-4f40-b09c-fc71d80f1779"},{"key":"quote_id","value":"Quote-TestingNewEndpoints"}],"variable":[]}},"response":[],"_postman_id":"f511a4e2-4ede-4e97-9284-c62c0db50ed9"},{"name":"Retrieve quote document status using your system quote ID","id":"c8f166d4-9888-4dc6-a71a-e71d6afcb448","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/api/quote/GetQuoteDocStatusByID?bgd_rfq_id=ed04a467-b2f7-4f40-b09c-fc71d80f1779"e_id=Quote-TestingNewEndpoints","description":"\n\n\n| Property name | \nData type | \nMandatory | \nDefinition | \n
\n\n\n\n| quote_id | \ncharacter varying | \nY | \nThis is the unique quote ID set by your system. | \n
\n\n
\n
Success: Boolean value of TRUE
\nFailure: quote_id not found
\nAPI response example
\nHere's a breakdown of the endpoint JSON response.
\n{\n \"results\": [\n {\n \"response\": [\n {\n \"quote_id\": \"Quote-TestingNewEndpoints\",\n \"quote_doc_id\": \"Doc-TestingNewEndpoints\",\n \"quote_doc_name\": \"sample.pdf\",\n \"quote_doc_type\": \"Quote\",\n \"quote_doc_url\": \"https://pdfobject.com/pdf/sample.pdf\",\n \"quote_doc_extension\": \"application/pdf\",\n \"status\": \"Created\"\n }\n ]\n }\n ]\n}\n\n
\n","urlObject":{"path":["api","quote","GetQuoteDocStatusByID"],"host":["{{base_url}}"],"query":[{"key":"bgd_rfq_id","value":"ed04a467-b2f7-4f40-b09c-fc71d80f1779"},{"key":"quote_id","value":"Quote-TestingNewEndpoints"}],"variable":[]}},"response":[],"_postman_id":"c8f166d4-9888-4dc6-a71a-e71d6afcb448"}],"id":"dd424612-45e2-42f0-adb1-ae39a1680ff3","description":"Quotes and supporting documents are shared between builder construction management apps and BuiltGrid. Additional information is included with each of the following endpoints.
\n","_postman_id":"dd424612-45e2-42f0-adb1-ae39a1680ff3","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"5bc456b8-aae3-4110-812d-6b125b35bbb2","id":"5bc456b8-aae3-4110-812d-6b125b35bbb2","name":"BuiltGrid - Builder Apps","type":"collection"}}},{"name":"Quote comparison","item":[{"name":"Retrieve quote comparison using BuiltGrid RFQ ID","id":"411f9db9-7da0-4518-84d2-b4f88b4d5e20","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/api/quotecomparison/GetQuoteComparison?bgd_rfq_id=890bbbbf-1b95-4bd7-a466-2d9b0b00be93","description":"As you can see below, only one data point is required. If there is at least one quote available associated with the requested RFQ ID, the endpoint response will include a quote comparison link.
\nNote: Base URL in production is https://app.builtgrid.com/
\n\n\n\n| Property name | \nData type | \nMandatory | \nDefinition | \n
\n\n\n\n| bgd_rfq_id | \ncharacter varying | \nY | \nThis is the value shared in RFQ endpoint response. | \n
\n\n
\n
Success: URL to view quote comparison
\nFailure: bgd_rfq_id not found
\nAPI response example
\nHere's a breakdown of the endpoint JSON response.
\n{\n \"results\": [\n {\n \"response\": \"URL\"\n }\n ]\n}\n\n
\n","urlObject":{"path":["api","quotecomparison","GetQuoteComparison"],"host":["{{base_url}}"],"query":[{"key":"bgd_rfq_id","value":"890bbbbf-1b95-4bd7-a466-2d9b0b00be93"}],"variable":[]}},"response":[],"_postman_id":"411f9db9-7da0-4518-84d2-b4f88b4d5e20"},{"name":"Retrieve quote comparison using Project ID","id":"18214cbb-5dc3-454a-970e-d8bc9fdb1ee0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/api/quotecomparison/GetQuoteComparisonByProject?project_id=890bbbbf-1b95-4bd7-a466-2d9b0b00be93","description":"Base url is https://app.builtgrid.com/
\nAs you can see below, only one data point is required. If there is at least one quote available associated with the requested RFQ ID, the endpoint response will nclude a quote comparison link.
\n\n\n\n| Property name | \nData type | \nMandatory | \nDefinition | \n
\n\n\n\n| project_id | \ncharacter varying | \nY | \nPartner App project's ID | \n
\n\n
\n
Success: URL to view quote comparisons available in the project with RFQ BGD ID
\nFailure: Project not found
\nAPI response example
\nHere's a breakdown of the endpoint JSON response.
\n{\n{\n \"data\": [\n {\n \"results\": [\n {\n \"rfq_bgd_id\": \"1d281c6c-3486-4b9d-ac1e-406967e39864\",\n \"quote_comparison\": \"builder/quote_comparison/b81c3d19-4d4d-42f9-926a-2ed45225223a\"\n },\n {\n \"rfq_bgd_id\": \"744269df-ec8f-47f4-bee8-9426ff71a04b\",\n \"quote_comparison\": \"Waiting suppliers to send quotes\"\n },\n {\n \"rfq_bgd_id\": \"f18e7a96-aa59-41e5-845f-741edc9a7bf0\",\n \"quote_comparison\": \"builder/quote_comparison/90c99ade-ca7b-465a-9f9f-0ba0b69e72c6\"\n }\n ]\n }\n ]\n}\n\n
\n","urlObject":{"path":["api","quotecomparison","GetQuoteComparisonByProject"],"host":["{{base_url}}"],"query":[{"key":"project_id","value":"890bbbbf-1b95-4bd7-a466-2d9b0b00be93"}],"variable":[]}},"response":[],"_postman_id":"18214cbb-5dc3-454a-970e-d8bc9fdb1ee0"}],"id":"9138756d-9324-4e8f-9968-684ca4802b73","description":"This is an optional endpoint and relevant if you don't have quote and order functions in your app (eg. Estimating app). This endpoint will respond with a quote comparison page link. On this page, your user can review a side-by-side quote comparison including pricing, terms, quote links, etc.. Your builder customer can order and schedule from the comparison page.
\nQuote simulation
\nWhile in development or testing mode using staging server, we need to manually submit quotes on your behalf to simulate supplier quote responses. Send us a request by Slack or email.
\n","_postman_id":"9138756d-9324-4e8f-9968-684ca4802b73","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"5bc456b8-aae3-4110-812d-6b125b35bbb2","id":"5bc456b8-aae3-4110-812d-6b125b35bbb2","name":"BuiltGrid - Builder Apps","type":"collection"}}},{"name":"Order","item":[{"name":"Create or update a purchase order","id":"da755c6b-cbf6-4cc6-b100-bcea36fa5ad8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"data\": [\n {\n \"order_id\": \"Order-TestingNewEndpoints\",\n \"quote_id\": \"Quote-TestingNewEndpoints\",\n \"rfq_id\": \"RFQ-TestingNewEndpoints\",\n \"supplier_id\": \"TestingNewEndpoints2\",\n \"supplier_trading_name\": \"ContactForTest\",\n \"order_required_date\": \"2024-09-10\",\n \"order_date\": \"2024-09-10\",\n \"order_reference\": \"2024-07-15\",\n \"total_cost_exc\": \"10000\",\n \"total_tax\": \"102\",\n \"total_cost_inc\": \"112\",\n \"delivery_included\": \"true\",\n \"terms\": \"Terms\",\n \"comment\": \"Comment\", \n \"item\":[{\n \"order_item_id\": \"200\",\n \"order_item_name\": \"Item Name\",\n \"order_item_quantity\": \"200\",\n \"order_item_uom\": \"m2\",\n \"order_item_cost_exc\": \"1200.00\",\n \"order_item_tax\": \"1200.00\",\n \"order_item_cost_inc\": \"1500.00\",\n \"order_item_cost_subtotal_exc\": \"1320.00\",\n \"order_item_cost_subtotal_inc\": \"1320.00\", \n \"order_item_comment\": \"Comment\"\n },\n {\n \"order_item_id\": \"300\",\n \"order_item_name\": \"Item Name 1\",\n \"order_item_quantity\": \"300\",\n \"order_item_uom\": \"m2\",\n \"order_item_cost_exc\": \"1300.00\",\n \"order_item_tax\": \"1300.00\",\n \"order_item_cost_inc\": \"1500.00\",\n \"order_item_cost_subtotal_exc\": \"1350.00\",\n \"order_item_cost_subtotal_inc\": \"120.00\", \n \"order_item_comment\": \"Comment\"\n }\n\n ]\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/api/order/createupdateorder","description":"If the purchase order is generated in your system for an RFQ associated with BuiltGrid, this endpoint posts the data to BuiltGrid for sharing with the applicable supplier for agreement and signing.
\nThis process includes an agreed scheduled date for delivery or onsite services.
\npost_po_create_update field definitions are as follows:
\n\n\n\n| Property name | \nDate type | \nMandatory | \nDefinition | \n
\n\n\n\n| order_id | \ncharacter varying | \nY | \nThis is the unique order ID set by your system. | \n
\n\n| quote_id | \ncharacter varying | \nY | \nThis is the unique quote ID set by your system. | \n
\n\n| rfq_id | \ncharacter varying | \nY | \nThis is the unique RFQ ID set by your system. | \n
\n\n| supplier_id | \ncharacter varying | \nY | \nThis is the unique supplier_id set by your system. | \n
\n\n| supplier_trading_name | \ncharacter varying | \n | \nThis is the supplier business name as set by customer in your system. | \n
\n\n| order_date | \ntimestamp with time zone | \nY | \nThe creation date of the PO as set by the supplier in their system. | \n
\n\n| order_reference | \ncharacter varying | \nY | \nThe id of the PO as set by the supplier in their system. | \n
\n\n| total_cost_exc | \nnumeric | \nY | \nThe grand total of all items subtotals excluding tax in dollar terms, as set by the supplier in their system. | \n
\n\n| total_tax | \nnumeric | \nY | \nThe grand total of all items subtotals tax amount in dollar terms, as set by the supplier in their system. | \n
\n\n| total_cost_inc | \nnumeric | \nY | \nThe grand total of all items subtotals including tax in dollar terms, as set by the supplier in their system. | \n
\n\n| delivery_included | \nboolean | \n | \nA flag to indicate if the quote includes or excludes delivery fee. Typically true or false as set by the supplier in their system. | \n
\n\n| terms | \ncharacter varying | \n | \nThe summary payment terms associated with the quote as set by the supplier in their system. Limited to 25 characteres. | \n
\n\n| comment | \ncharacter varying | \n | \nThe summary comment of the quote as set by the supplier in their system. | \n
\n\n| order_item_id | \ncharacter varying | \nItem array | \nAll item fields are part of an array. The item ID or SKU (Stock Keeping Unit) as set by the supplier in their system. | \n
\n\n| order_item_name | \ncharacter varying | \nItem array | \nThe characters used in item name, as set by the supplier in their system. | \n
\n\n| order_item_quantity | \nnumeric | \nItem array | \nThe quantity of items, as set by the supplier in their system. Up to four decimal points. | \n
\n\n| order_item_uom | \ncharacter varying | \nItem array | \nThe UOM (Unit of Measure) of items, as set by the supplier in their system. Eg. Each, LM, M2, M3, etc... | \n
\n\n| order_item_cost_exc | \nnumeric | \nItem array | \nThe item cost excluding tax in dollar terms, as set by the supplier in their system. Up to four decimal points. | \n
\n\n| order_item_tax | \nnumeric | \nItem array | \nThe item tax amount in dollar terms, as set by the supplier in their system. Up to four decimal points. | \n
\n\n| order_item_cost_inc | \nnumeric | \nItem array | \nThe item cost including tax in dollar terms, as set by the supplier in their system. Up to four decimal points. | \n
\n\n| order_item_cost_subtotal_exc | \nnumeric | \nItem array | \nThe subtotal is the quantity multiplied by the cost excluding tax in dollar terms, as set by the supplier in their system. Up to four decimal points. | \n
\n\n| order_item_cost_subtotal_inc | \nnumeric | \nItem array | \nThe subtotal is the quantity multiplied by the cost including tax in dollar terms, as set by the supplier in their system. Up to four decimal points. | \n
\n\n| order_item_comment | \ntext | \n | \nThe item-specific comments, as set by the supplier in their system. | \n
\n\n
\n
Success: Boolean value of TRUE.
Failure: bgd_rfq_id not found.
\n","urlObject":{"path":["api","order","createupdateorder"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"da755c6b-cbf6-4cc6-b100-bcea36fa5ad8"},{"name":"Create or update a purchase order V2","id":"d663c465-f299-4c64-9d57-e352fcf6cf2a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"data\": [\n {\n \"order_id\": \"Order-TestingNewEndpoints\",\n \"quote_id\": \"Quote-TestingNewEndpoints\",\n \"rfq_id\": \"RFQ-TestingNewEndpoints\",\n \"supplier_id\": \"TestingNewEndpoints2\",\n \"supplier_trading_name\": \"ContactForTest\",\n \"order_required_date\": \"2024-09-10\",\n \"order_date\": \"2024-09-10\",\n \"order_reference\": \"2024-07-15\",\n \"total_cost_exc\": \"10000\",\n \"total_tax\": \"102\",\n \"total_cost_inc\": \"112\",\n \"delivery_included\": \"true\",\n \"terms\": \"Terms\",\n \"comment\": \"Comment\", \n \"item\":[{\n \"order_item_id\": \"200\",\n \"order_item_name\": \"Item Name\",\n \"order_item_quantity\": \"200\",\n \"order_item_uom\": \"m2\",\n \"order_item_cost_exc\": \"1200.00\",\n \"order_item_tax\": \"1200.00\",\n \"order_item_cost_inc\": \"1500.00\",\n \"order_item_cost_subtotal_exc\": \"1320.00\",\n \"order_item_cost_subtotal_inc\": \"1320.00\", \n \"order_item_comment\": \"Comment\"\n },\n {\n \"order_item_id\": \"300\",\n \"order_item_name\": \"Item Name 1\",\n \"order_item_quantity\": \"300\",\n \"order_item_uom\": \"m2\",\n \"order_item_cost_exc\": \"1300.00\",\n \"order_item_tax\": \"1300.00\",\n \"order_item_cost_inc\": \"1500.00\",\n \"order_item_cost_subtotal_exc\": \"1350.00\",\n \"order_item_cost_subtotal_inc\": \"120.00\", \n \"order_item_comment\": \"Comment\"\n }\n\n ]\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/api/order/createupdateorderv2","description":"This endpoint is intended for creating a quote in BGD when the associated RFQ was created (or updated) via the Create or update a request for quote V2 endpoint.
\nIf the purchase order is generated in your system for an RFQ associated with BuiltGrid, this endpoint posts the data to BuiltGrid for sharing with the applicable supplier for agreement and signing.
\nThis process includes an agreed scheduled date for delivery or onsite services.
\npost_po_create_update field definitions are as follows:
\n\n\n\n| Property name | \nDate type | \nMandatory | \nDefinition | \n
\n\n\n\n| order_id | \ncharacter varying | \nY | \nThis is the unique order ID set by your system. | \n
\n\n| quote_id | \ncharacter varying | \nY | \nThis is the unique quote ID set by your system. | \n
\n\n| rfq_id | \ncharacter varying | \nY | \nThis is the unique RFQ ID set by your system. | \n
\n\n| supplier_id | \ncharacter varying | \nY | \nThis is the unique supplier_id set by your system. | \n
\n\n| supplier_trading_name | \ncharacter varying | \n | \nThis is the supplier business name as set by customer in your system. | \n
\n\n| order_date | \ntimestamp with time zone | \nY | \nThe creation date of the PO as set by the supplier in their system. | \n
\n\n| order_reference | \ncharacter varying | \nY | \nThe id of the PO as set by the supplier in their system. | \n
\n\n| total_cost_exc | \nnumeric | \nY | \nThe grand total of all items subtotals excluding tax in dollar terms, as set by the supplier in their system. | \n
\n\n| total_tax | \nnumeric | \nY | \nThe grand total of all items subtotals tax amount in dollar terms, as set by the supplier in their system. | \n
\n\n| total_cost_inc | \nnumeric | \nY | \nThe grand total of all items subtotals including tax in dollar terms, as set by the supplier in their system. | \n
\n\n| delivery_included | \nboolean | \n | \nA flag to indicate if the quote includes or excludes delivery fee. Typically true or false as set by the supplier in their system. | \n
\n\n| terms | \ncharacter varying | \n | \nThe summary payment terms associated with the quote as set by the supplier in their system. Limited to 25 characteres. | \n
\n\n| comment | \ncharacter varying | \n | \nThe summary comment of the quote as set by the supplier in their system. | \n
\n\n| order_item_id | \ncharacter varying | \nItem array | \nAll item fields are part of an array. The item ID or SKU (Stock Keeping Unit) as set by the supplier in their system. | \n
\n\n| order_item_name | \ncharacter varying | \nItem array | \nThe characters used in item name, as set by the supplier in their system. | \n
\n\n| order_item_quantity | \nnumeric | \nItem array | \nThe quantity of items, as set by the supplier in their system. Up to four decimal points. | \n
\n\n| order_item_uom | \ncharacter varying | \nItem array | \nThe UOM (Unit of Measure) of items, as set by the supplier in their system. Eg. Each, LM, M2, M3, etc... | \n
\n\n| order_item_cost_exc | \nnumeric | \nItem array | \nThe item cost excluding tax in dollar terms, as set by the supplier in their system. Up to four decimal points. | \n
\n\n| order_item_tax | \nnumeric | \nItem array | \nThe item tax amount in dollar terms, as set by the supplier in their system. Up to four decimal points. | \n
\n\n| order_item_cost_inc | \nnumeric | \nItem array | \nThe item cost including tax in dollar terms, as set by the supplier in their system. Up to four decimal points. | \n
\n\n| order_item_cost_subtotal_exc | \nnumeric | \nItem array | \nThe subtotal is the quantity multiplied by the cost excluding tax in dollar terms, as set by the supplier in their system. Up to four decimal points. | \n
\n\n| order_item_cost_subtotal_inc | \nnumeric | \nItem array | \nThe subtotal is the quantity multiplied by the cost including tax in dollar terms, as set by the supplier in their system. Up to four decimal points. | \n
\n\n| order_item_comment | \ntext | \n | \nThe item-specific comments, as set by the supplier in their system. | \n
\n\n
\n
Success: Boolean value of TRUE.
Failure: bgd_rfq_id not found.
\n","urlObject":{"path":["api","order","createupdateorderv2"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"d663c465-f299-4c64-9d57-e352fcf6cf2a"},{"name":"Retrieve order contract using BuiltGrid RFQ ID","id":"143dc546-453e-4c14-8ed4-6eb7213cbed1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/api/order/GetOrderByRFQ?bgd_rfq_id=ed04a467-b2f7-4f40-b09c-fc71d80f1779","description":"Once a purchase order is signed, we will use your webhook to trigger the GetOrderByRFQ endpoint.
\nThis endpoint shares the final purchase order contract, a URL to a PDF. The PDF wraps all of the purchasing activity into one file, like an audit trail that includes:
\n\nOrganisational and legal details of the contracting parties
\nOriginal RFQ and job scope
\nQuotes and supporting documents
\nOrder, estimated schedule and payment terms
\nSignatures of the parties
\n
\n\n\n\n| Property name | \nData type | \nMandatory | \nDefinition | \n
\n\n\n\n| bgd_rfq_id | \ncharacter varying | \nY | \nThis is the value shared in RFQ endpoint response. | \n
\n\n
\n
Success: BuiltGrid contract URL
\nFailure: bgd_rfq_id not found
\nAPI response example
\nHere's a breakdown of the endpoint JSON response.
\n{\n \"results\": [\n {\n \"order_id\": \"Order-TestingNewEndpoints\",\n \"quote_id\": \"Quote-TestingNewEndpoints\",\n \"rfq_id\": \"RFQ-TestingNewEndpoints\",\n \"supplier_id\": \"TestingNewEndpoints2\",\n \"supplier_trading_name\": \"TestingNewEndpoints2\",\n \"order_reference\": \"BGDPO12864456\",\n \"total_cost_exc\": \"4,909.09\",\n \"total_tax\": \"490.91\",\n \"total_cost_inc\": \"5,400.00\",\n \"delivery_included\": true,\n \"comment\": null,\n \"order_required_date\": \"2024-09-09T14:00:00.000Z\",\n \"order_supplier_signature_url\": \"Order is Under Offer\"\n }\n ]\n}\n\n
\n","urlObject":{"path":["api","order","GetOrderByRFQ"],"host":["{{base_url}}"],"query":[{"key":"bgd_rfq_id","value":"ed04a467-b2f7-4f40-b09c-fc71d80f1779"}],"variable":[]}},"response":[],"_postman_id":"143dc546-453e-4c14-8ed4-6eb7213cbed1"}],"id":"ff11d4e3-b98a-4497-96ac-c4d6b53d587f","description":"Orders are managed in two ways, depending on the order source.
\n1. Orders sent by your system
\nThe purchase order is generated in your system for an RFQ associated with BuiltGrid. The createupdateorder endpoint posts the data to BuiltGrid for sharing with the applicable supplier for agreement and signing. Once signed we will use your webhook to trigger the GetOrderByRFQ endpoint which includes the BuiltGrid contract.
\n2. Signed order contracts generated by BuiltGrid
\nPurchase orders are reviewed and signed by the supplier on the BuiltGrid platform. Once signed we will use your webhook to trigger the GetOrderByRFQ endpoint which includes the final BuiltGrid purchase order contract - a URL to a PDF that wraps all of the purchasing activity into one file, like an audit trail. There''s more detail in the endpoint description.
\n","_postman_id":"ff11d4e3-b98a-4497-96ac-c4d6b53d587f","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"5bc456b8-aae3-4110-812d-6b125b35bbb2","id":"5bc456b8-aae3-4110-812d-6b125b35bbb2","name":"BuiltGrid - Builder Apps","type":"collection"}}}],"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":""}]}},"event":[{"listen":"prerequest","script":{"id":"ffc567ed-1837-4dc0-bd3b-6afed6ea6591","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"31c0b094-0f9e-4f9e-998a-ddccbcac34ba","type":"text/javascript","exec":[""]}}]}![https://builtgrid.com/assets/images/BuiltGrid_Logo_Colour_Wide.svg](\"https://builtgrid.com/assets/images/BuiltGrid_Logo_Colour_Wide.svg\"){kind=link}
![https://app.builtgrid.com/assets/media/BGD_Logo_Hori_500p.png](\"https://app.builtgrid.com/assets/media/BGD_Logo_Hori_500p.png\"){kind=link}