The ProcureDesk API allows seamless integration with ProcureDesk's purchasing and accounts payable platform, providing robust functionality for managing vendor orders, purchase requisitions, invoices, and other procurement workflows. Designed for businesses looking to streamline their procurement processes, the API offers endpoints to create, read, update, and delete purchasing-related data, allowing companies to build automated workflows, improve efficiency, and gain greater visibility into their spending.
\nWith the ProcureDesk API, users can integrate their existing systems to:
\nAutomate purchase order and invoice processing.
\nGain real-time insights into purchasing and vendor data.
\nEnhance workflows for approvals, budgets, and compliance.
\nSimplify procurement management across teams and locations.
\nThe ProcureDesk API allows seamless integration with ProcureDesk's purchasing and accounts payable platform, enabling automated workflows for managing vendor orders, purchase requisitions, invoices, and procurement data. This API supports companies in automating processes, improving efficiency, and gaining visibility into their spending.
\nUse the /api/authenticate endpoint to obtain an access token.
Include this token in the Authorization header for all subsequent requests as Bearer {access_token}.
Example Authentication Request:
\nPOST /api/authenticate\n{\n \"api_user\": {\n \"email\": \"user@example.com\",\n \"password\": \"YourSecurePassword123!\"\n }\n}\n\nPurchase Orders: /api/v2/po/create_po – Create and manage POs.
Vendor Orders: /api/vendor_order – Submit and track vendor orders.
Invoices: /api/invoices – Manage invoice processing.
Authorization header with your access token.400 Bad Request for missing parameters and 401 Unauthorized for invalid tokens.Keep access tokens secure and avoid hardcoding them in public code.
\nRespect API rate limits and use pagination where supported.
\nURL: POST /api/authenticate
Full URL: https://myprocuredesk.com/api/authenticate
This endpoint authenticates users by validating their credentials and returns an authentication token, which is required for accessing other API endpoints.
\napplication/json (Required)The request body must be in JSON format and should include the following parameters:
\nObject containing the user credentials for authentication.
\nemail (String, Required)
The email address associated with the user account in ProcureDesk.
Example: \"email\": \"user@example.com\"
password (String, Required)
The password is associated with the user’s account. Ensure this is securely stored and handled.
Example: \"password\": \"YourSecurePassword123!\"
{\n \"api_user\": {\n \"email\": \"user@example.com\",\n \"password\": \"YourSecurePassword123!\"\n }\n}\n\nIf authentication is successful, the server will return a JSON response containing an access token. This token must be included in the headers of subsequent API requests to authorize access.
\n{\n \"access_token\": \"eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxMDc3MCwiZXhwIjoxNzMyMzA3MDkxfQ.9ltLnv0jZGnAoEnKHubV84RjqniLe6tLAPnq1qLObQA\"\n}\n\nThe access_token is essential for authenticating API requests; include it in the Authorization header for each request that requires authentication.
Authorization Header Format:
\nFormat: Authorization: Bearer {access_token}
Replace {access_token} with the actual token from the response.
This section explains how to securely access the API by validating user credentials and obtaining an authentication token. The token is required for authorizing subsequent requests to protected endpoints, ensuring secure and controlled access to your data.
\nThis section covers:
\nAuthentication Flow: How to authenticate and obtain a token.
\nToken Management: Best practices for using, refreshing, and storing your authentication token.
\nHeaders and Formats: How to include the token in API requests.
\nPOST: /api/v2/po/create_po
\nThe request body for the vendor_order endpoint contains the following fields:
vendor_orderorder_items_attributes{\n \"vendor_order\": {\n \"business_unit\": \"ProcureDesk\",\n \"description\": \"Test Order\",\n \"locationable_type\": \"Location\",\n \"location\": \"Cincinnati\",\n \"state\": \"Draft\",\n \"contact\": \"Test User\",\n \"department\": \"HR\",\n \"order_items_attributes\": [\n {\n \"item_description\": \"Sample Description\",\n \"supplier\": \"Apple\",\n \"uom_master\": \"EA\",\n \"list_price\": \"200\",\n \"item_type\": \"material\",\n \"account\": \"Office Supplies\",\n \"quantity\": \"1\",\n \"budget_value_breakup_name\": \"Accounts\"\n }\n ]\n }\n}\n\nUpdate purchase orders is currently only updating the order header. Line item update should be available soon.
\n","urlObject":{"protocol":"https","path":["api","v2","po","477565"],"host":["myprocuredesk","com"],"query":[{"disabled":true,"key":"","value":""}],"variable":[]}},"response":[],"_postman_id":"ba67c9a2-0583-4586-844d-3e6b4b628d00"},{"name":"Delete","id":"91751128-a7fa-4422-a4d6-1b175402c33b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Method: DELETE
Endpoint: https://myprocuredesk.com/api/v2/po/{id}
This endpoint is used to delete a specific purchase order based on its unique ID. The id must be passed as part of the URL path.
Ensure that the ID corresponds to an existing purchase order; otherwise, the request will return an error.
\nThis action is irreversible. Once the purchase order is deleted, it cannot be recovered.
\nID Validation: Ensure the ID is valid and corresponds to an existing purchase order.
\nIrreversibility: Clearly communicate to users that this action is irreversible (as you mentioned).
\nData Integrity: In a real-world application, ensure that you handle related data properly. For example, if other entities depend on the purchase order (like invoices or transactions), consider cascading deletions or soft deletions.
\nMethod: GET
Endpoint: https://myprocuredesk.com/api/v2/po/{id}
}
\nexplain this response int able firmat
\nHere's the response formatted in a table:
\nOrder Suppliers with Locations (Vertical Format)
\n{
\"success\": true,
\"result\": {
\"id\": 18957,
\"customer_id\": 188,
\"company_id\": 25,
\"contact_id\": 188,
\"order_contact_name\": \"Test User 1\",
\"order_contact_designation\": \"Analyst Sr.\",
\"parent_order_id\": null,
\"state\": \"Sent To Supplier\",
\"name\": \"\",
\"description\": \"test\",
\"slug\": \"2647\",
\"sub_total\": \"575.0\",
\"created_at\": \"2025-01-30T10:39:49.822Z\",
\"updated_at\": \"2025-01-30T10:41:36.664Z\",
\"noti_message\": \"\",
\"department_id\": 1266,
\"department_name\": \"Engg\",
\"line_item_count\": 2,
\"shipping\": \"0.0\",
\"tax\": \"0.0\",
\"supplier_name\": \"Supplier Test\",
\"supplier_number\": \"1738230955\",
\"payment_method_name\": \"ACH\",
\"business_unit_id\": 84,
\"business_unit_name\": \"QA BU\",
\"is_urgent\": false,
\"type\": \"VendorOrder\",
\"payment_method_id\": 159,
\"prorate_tax\": true,
\"locationable_type\": \"Location\",
\"locationable_id\": 3113,
\"location_name\": \"TEST APPLICATION ORDRRS\",
\"source_type\": \"standard\",
\"markup_subtotal\": \"0.0\",
\"cost_type\": \"capex\",
\"release_date\": \"2025-01-30\",
\"applied_amount\": \"0.0\",
\"order_total\": \"575.0\",
\"txn_date\": \"2025-01-30\",
\"order_date\": \"2025-01-30\",
\"custom_slug\": \"100341\",
\"created_by\": \"Test User 1\",
\"line_items\": [
{
\"id\": 52875,
\"line_no\": 1,
\"item_no\": \"1242989\",
\"itemable_type\": \"Order\",
\"supplier_id\": 16663,
\"supplier\": \"Supplier Test\",
\"supplier_item_no\": \"2345677\",
\"supplier_number\": \"1738230955\",
\"category_name\": \"Furniture\",
\"unit_price\": \"500.0\",
\"total_price\": \"500.0\",
\"price\": \"500.0\",
\"quantity\": \"1.0\",
\"required_date\": \"2025-01-30\",
\"item_name\": \"Test 11122\",
\"item_description\": \"Test\",
\"mfr_name\": \"Lenovo\",
\"mfr_no\": \"LN347643232\",
\"list_price\": \"500.0\",
\"lead_time\": 5,
\"moq\": \"1\",
\"image_url\": \"https://images-na.ssl-images-amazon.com/images/I/41ouk1MXCeL.AC_US218.jpg\",
\"unspsc_id\": \"2344323\",
\"status\": \"Not Delivered\",
\"preferred_item\": true,
\"match_type\": \"material\",
\"shipping\": \"0.0\",
\"sales_tax\": \"0.0\",
\"other_charges\": \"0.0\",
\"uom\": \"EACH\",
\"markup_percentage\": \"2.0\",
\"total_markup_price\": \"0.0\",
\"line_type\": \"catalog\",
\"total_payment_amount\": \"0.0\",
\"line_total\": \"500.0\",
\"class_master_id\": 88,
\"default_account_id\": 468,
\"account_name\": \"Test\",
\"state\": \"Not Delivered\",
\"is_cancelled\": false,
\"discount\": \"0.0\",
\"user_tax_id\": 32,
\"source_from\": \"vendor\",
\"shared_price\": \"500.0\",
\"line_item_id\": 30379,
\"class\": \"test\",
\"tracking_categories\": []
}
],
\"approvals_data\": {
\"Level 1\": {
\"id\": 168419,
\"state\": \"approved\",
\"approved_by\": \"Test User 2\",
\"designation\": \"Director\",
\"workflow_type\": \"standard\",
\"reviewer_only\": false,
\"is_adhoc\": false
}
},
\"order_suppliers_with_locations\": [
{
\"supplier_name\": \"Supplier Test\",
\"po_method\": \"Email\",
\"supplier_locations\": [
{
\"location_id\": 16279,
\"is_checked\": true,
\"contact_email\": \"test@gmail.com\"
}
]
}
],
\"comments\": [],
\"attachments\": [],
\"custom_fields\": []
}
}
Method: GET
Endpoint: https://myprocuredesk.com/api/v2/po/{id}
}
\nexplain this response int able firmat
\nHere's the response formatted in a table:
\nOrder Suppliers with Locations (Vertical Format)
\n{
\"success\": true,
\"result\": {
\"id\": 18957,
\"customer_id\": 188,
\"company_id\": 25,
\"contact_id\": 188,
\"order_contact_name\": \"Test User 1\",
\"order_contact_designation\": \"Analyst Sr.\",
\"parent_order_id\": null,
\"state\": \"Sent To Supplier\",
\"name\": \"\",
\"description\": \"test\",
\"slug\": \"2647\",
\"sub_total\": \"575.0\",
\"created_at\": \"2025-01-30T10:39:49.822Z\",
\"updated_at\": \"2025-01-30T10:41:36.664Z\",
\"noti_message\": \"\",
\"department_id\": 1266,
\"department_name\": \"Engg\",
\"line_item_count\": 2,
\"shipping\": \"0.0\",
\"tax\": \"0.0\",
\"supplier_name\": \"Supplier Test\",
\"supplier_number\": \"1738230955\",
\"payment_method_name\": \"ACH\",
\"business_unit_id\": 84,
\"business_unit_name\": \"QA BU\",
\"is_urgent\": false,
\"type\": \"VendorOrder\",
\"payment_method_id\": 159,
\"prorate_tax\": true,
\"locationable_type\": \"Location\",
\"locationable_id\": 3113,
\"location_name\": \"TEST APPLICATION ORDRRS\",
\"source_type\": \"standard\",
\"markup_subtotal\": \"0.0\",
\"cost_type\": \"capex\",
\"release_date\": \"2025-01-30\",
\"applied_amount\": \"0.0\",
\"order_total\": \"575.0\",
\"txn_date\": \"2025-01-30\",
\"order_date\": \"2025-01-30\",
\"custom_slug\": \"100341\",
\"created_by\": \"Test User 1\",
\"line_items\": [
{
\"id\": 52875,
\"line_no\": 1,
\"item_no\": \"1242989\",
\"itemable_type\": \"Order\",
\"supplier_id\": 16663,
\"supplier\": \"Supplier Test\",
\"supplier_item_no\": \"2345677\",
\"supplier_number\": \"1738230955\",
\"category_name\": \"Furniture\",
\"unit_price\": \"500.0\",
\"total_price\": \"500.0\",
\"price\": \"500.0\",
\"quantity\": \"1.0\",
\"required_date\": \"2025-01-30\",
\"item_name\": \"Test 11122\",
\"item_description\": \"Test\",
\"mfr_name\": \"Lenovo\",
\"mfr_no\": \"LN347643232\",
\"list_price\": \"500.0\",
\"lead_time\": 5,
\"moq\": \"1\",
\"image_url\": \"https://images-na.ssl-images-amazon.com/images/I/41ouk1MXCeL.AC_US218.jpg\",
\"unspsc_id\": \"2344323\",
\"status\": \"Not Delivered\",
\"preferred_item\": true,
\"match_type\": \"material\",
\"shipping\": \"0.0\",
\"sales_tax\": \"0.0\",
\"other_charges\": \"0.0\",
\"uom\": \"EACH\",
\"markup_percentage\": \"2.0\",
\"total_markup_price\": \"0.0\",
\"line_type\": \"catalog\",
\"total_payment_amount\": \"0.0\",
\"line_total\": \"500.0\",
\"class_master_id\": 88,
\"default_account_id\": 468,
\"account_name\": \"Test\",
\"state\": \"Not Delivered\",
\"is_cancelled\": false,
\"discount\": \"0.0\",
\"user_tax_id\": 32,
\"source_from\": \"vendor\",
\"shared_price\": \"500.0\",
\"line_item_id\": 30379,
\"class\": \"test\",
\"tracking_categories\": []
}
],
\"approvals_data\": {
\"Level 1\": {
\"id\": 168419,
\"state\": \"approved\",
\"approved_by\": \"Test User 2\",
\"designation\": \"Director\",
\"workflow_type\": \"standard\",
\"reviewer_only\": false,
\"is_adhoc\": false
}
},
\"order_suppliers_with_locations\": [
{
\"supplier_name\": \"Supplier Test\",
\"po_method\": \"Email\",
\"supplier_locations\": [
{
\"location_id\": 16279,
\"is_checked\": true,
\"contact_email\": \"test@gmail.com\"
}
]
}
],
\"comments\": [],
\"attachments\": [],
\"custom_fields\": []
}
}
Endpoint
\nMethod: GET
Endpoint: https://myprocuredesk.com/api/v2/orders
This endpoint retrieves a list of purchase orders based on the provided filters such as max_results, page, and modified_date. The response includes order metadata and allows pagination for large datasets.
![Image](\"https://images-na.ssl-images-amazon.com/images/I/41ouk1MXCeL._AC_US218_.jpg\"){kind=link}
https://myprocuredesk.com/api/v2/orders?max_results=2&page=&modified_date=2024-11-08\n\n{\n \"success\": true,\n \"result\": [\n {\n \"id\": 481382,\n \"slug\": \"1038\",\n \"description\": \"dhgcvhjdvcjdhc\",\n \"slug_no\": \"po-2024-30292\",\n \"created_on\": \"11/15/2024\",\n \"creatable_name\": \"Anubhav Srivastava\",\n \"supplier_name\": \"Amazon.com\",\n \"order_total_with_currency\": \"EUR 541.00\",\n \"state_titleize\": \"Pending Approval\",\n \"attachments\": []\n },\n {\n \"id\": 481365,\n \"slug\": \"1037\",\n \"description\": \"cjdvdjhvcjdhsvjhcsdc\",\n \"slug_no\": \"po-2024-30291\",\n \"created_on\": \"11/15/2024\",\n \"creatable_name\": \"Anubhav Srivastava\",\n \"supplier_name\": \"15th Sep\",\n \"order_total_with_currency\": \"EUR 100.00\",\n \"state_titleize\": \"Approved\",\n \"attachments\": []\n }\n ]\n}\n\nresult (Array Item)This response includes the most important metadata for orders, such as supplier information, order status, and creator details.
\nEmpty fields (e.g., attachments) are included in the response for consistency but may not always contain data.
Ensure correct query parameters are used to retrieve filtered results effectively.
\nDate format: Year-Month-Date
\n","type":"text/plain"},"key":"modified_date","value":"2024-11-08"}],"variable":[]}},"response":[],"_postman_id":"8456cbfb-b03f-4b91-bef5-02e744c8e140"}],"id":"18664b1a-e605-4719-843a-b92aad0f252c","description":"The Purchase Orders API is a powerful tool for managing purchase orders (POs) throughout the procurement lifecycle. It provides capabilities to create, update, retrieve, delete, and list purchase orders, ensuring efficient tracking of purchasing activities and alignment with organizational approval workflows.
\nCreate Purchase Orders:
\nUpdate Purchase Orders:
\nRetrieve Purchase Orders:
\nDelete Purchase Orders:
\nList Purchase Orders:
\nMethod: POST
Endpoint: /api/v2/receipts
https://myprocuredesk.com/api/v2/receipts?purchase_order_id=12345\n\n{\n \"receipt_date\": \"11/09/2024\",\n \"state\": \"Approved\",\n \"department_name\": \"HR\",\n \"line_items\": [\n {\n \"id\": 3821459,\n \"line_no\": 1,\n \"received_qty\": \"1.0\",\n \"is_received\": true\n }\n ]\n}\n\n{\n \"success\": true,\n \"result\": {\n \"id\": 3019,\n \"number\": \"30000438\",\n \"slug\": \"30000438\",\n \"packing_number\": null,\n \"receipt_date\": \"02/18/2025\",\n \"shipping_date\": \"02/18/2025\",\n \"state\": \"Draft\",\n \"po_slug\": \"2230\",\n \"created_at\": \"02/18/2025\",\n \"department_name\": \"Administration\",\n \"department_label_name\": \"Department\",\n \"inventory_location_name\": null,\n \"inventory_location_id\": null,\n \"is_inventory\": true,\n \"attachment_name\": null,\n \"attachment_url\": null,\n \"line_items\": [\n {\n \"id\": 5374,\n \"line_no\": 1,\n \"is_received\": true,\n \"item_no\": \"8787588\",\n \"item_description\": \"Test\",\n \"ordered_qty\": \"5.0\",\n \"invoiced_qty\": \"0.0\",\n \"received_qty\": \"4.0\",\n \"uom\": \"EACH\",\n \"list_price\": \"75.0\"\n }\n ],\n \"attachments\": []\n }\n}\n\nresultline_items - Array of Objects)attachments - Array)⚠This endpoint is currently not available in this version.
\nMethod: PUT
Endpoint: https://myprocuredesk.com/api/v2/receipts/{id}
This endpoint is used to update an existing receipt. It modifies receipt details such as receipt date, state, department, and the received items.
\nhttpCopy codePUT https://myprocuredesk.com/api/v2/receipts/374030\n\njsonCopy code{\n \"receipt_date\": \"11/09/2024\",\n \"state\": \"Approved\",\n \"department_name\": \"HR\",\n \"line_items\": [\n {\n \"id\": 3821459,\n \"line_no\": 1,\n \"received_qty\": \"1.0\",\n \"is_received\": true\n }\n ]\n}\n\njsonCopy code{\n \"success\": true,\n \"message\": \"Receipt updated successfully.\",\n \"receipt_details\": {\n \"id\": 374030,\n \"receipt_date\": \"11/09/2024\",\n \"state\": \"Approved\",\n \"department_name\": \"HR\",\n \"line_items\": [\n {\n \"id\": 3821459,\n \"line_no\": 1,\n \"received_qty\": \"1.0\",\n \"is_received\": true\n }\n ]\n }\n}\n\nreceipt_detailsURL Parameter:
\n{id} in the URL must be replaced with the unique receipt ID to update.Validation:
\nEnsure the id in line_items matches valid line items from the original receipt or associated purchase order.
The received_qty must not exceed the original ordered quantity.
Error Handling:
\nAuthorization: Only users with the appropriate permissions can update receipts.
\nMethod: DELETE
Endpoint: /api/v2/receipts/{id}
This endpoint is used to delete an existing receipt based on its unique ID. Once deleted, the receipt cannot be recovered.
\nDELETE /api/v2/receipts/{id}\n\nDELETE /api/v2/receipts/374028\n\n{\n \"success\": true,\n \"message\": \"Receipt deleted successfully.\"\n}\n\nURL Parameter:
\n{id} must be replaced with the unique receipt ID to delete.Irreversible Action:
\nError Handling:
\nIf the receipt ID does not exist, the API will return an error message.
\nEnsure the receipt is not linked to any ongoing processes before deleting.
\nAuthorization: Only users with the appropriate permissions can delete receipts.
\nMethod: GET
Endpoint: /api/v2/receipts/{id}
This endpoint retrieves details of a specific receipt using its unique ID. The response contains metadata about the receipt, associated line items, and attachments.
\nGET /api/v2/receipts/{id}\n\nGET /api/v2/receipts/373690\n\n{\n \"success\": true,\n \"result\": {\n \"id\": 373690,\n \"number\": \"30000780\",\n \"slug\": \"30000780\",\n \"packing_number\": \"\",\n \"receipt_date\": \"11/08/2024\",\n \"shipping_date\": \"11/08/2024\",\n \"state\": \"Approved\",\n \"po_slug\": \"po-2024-30277\",\n \"created_at\": \"11/08/2024\",\n \"department_name\": \"IT\",\n \"department_label_name\": \"Site\",\n \"inventory_location_name\": null,\n \"inventory_location_id\": null,\n \"is_inventory\": false,\n \"attachment_name\": null,\n \"attachment_url\": null,\n \"line_items\": [\n {\n \"id\": 962756,\n \"line_no\": 1,\n \"is_received\": true,\n \"item_no\": \"IT1\",\n \"item_description\": \"Laptop for the new hire\",\n \"ordered_qty\": \"1.0\",\n \"invoiced_qty\": \"1.0\",\n \"received_qty\": \"1.0\",\n \"uom\": \"DZ\",\n \"list_price\": \"500.0\"\n },\n {\n \"id\": 962757,\n \"line_no\": 2,\n \"is_received\": true,\n \"item_no\": \"IT2\",\n \"item_description\": \"Bag for the laptop\",\n \"ordered_qty\": \"1.0\",\n \"invoiced_qty\": \"1.0\",\n \"received_qty\": \"1.0\",\n \"uom\": \"DZ\",\n \"list_price\": \"100.0\"\n }\n ],\n \"attachments\": []\n }\n}\n\nresultline_items (Array Item)URL Parameter:
\n{id} in the URL must be replaced with the unique receipt ID to retrieve details.Response Structure:
\nline_items array provides a detailed breakdown of items received in the receipt.Error Handling:
\nAuthorization: Only users with the appropriate permissions can access this endpoint.
\nMethod: GET
Endpoint: /api/v2/receipts/all_receipts
This endpoint retrieves a paginated list of all receipts, with optional filtering by modification date. The response includes metadata for each receipt and supports pagination for large datasets.
\nGET /api/v2/receipts/all_receipts?page=2&modified_date=2024-11-08&max_results=2\n\n{\n \"success\": true,\n \"result\": [\n {\n \"id\": 375167,\n \"slug\": \"30000783\",\n \"number\": \"30000783\",\n \"packing_number\": \"\",\n \"receipt_date\": \"11/13/2024\",\n \"state\": \"Approved\",\n \"purchase_order_id\": 479584\n },\n {\n \"id\": 374603,\n \"slug\": \"30000782\",\n \"number\": \"30000782\",\n \"packing_number\": null,\n \"receipt_date\": \"11/12/2024\",\n \"state\": \"Draft\",\n \"purchase_order_id\": 477549\n }\n ],\n \"pagination\": {\n \"current_page\": 2,\n \"max_results\": 2,\n \"total_pages\": 5,\n \"total_results\": 10\n }\n}\n\nresult (Array Item)paginationQuery Parameters:
\nUse page and max_results together for paginated results.
Use modified_date to filter receipts modified on or after the given date.
Response Structure:
\nEach receipt in the result array includes metadata like id, number, state, and purchase_order_id.
Pagination details are provided in the pagination object.
Error Handling:
\nresult array will be returned.Authorization: Only users with the appropriate permissions can access this endpoint.
\nDate format: Year-Month-Date
\n","type":"text/plain"},"key":"modified_date","value":"2024-11-08"},{"key":"max_results","value":"2"}],"variable":[]}},"response":[],"_postman_id":"bdb47fe7-86e3-400e-8395-82a4108518d4"}],"id":"8579a168-c207-4738-a6d4-304cba69669b","description":"The Receipts API is a comprehensive interface for managing receipt records within a procurement workflow. It allows systems to seamlessly track, create, update, delete, and retrieve receipts, ensuring accurate documentation and reconciliation of goods or services received against purchase orders.
\n","_postman_id":"8579a168-c207-4738-a6d4-304cba69669b"},{"name":"Invoices","item":[{"name":"Create - Pending","id":"ead2680f-db19-4403-936e-daab9d860a6d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"⚠This endpoint is currently not available in this version.
\n","urlObject":{"protocol":"https","path":["api","v2","invoice","create_invoice"],"host":["myprocuredesk","com"],"query":[{"disabled":true,"key":"","value":""}],"variable":[]}},"response":[],"_postman_id":"ead2680f-db19-4403-936e-daab9d860a6d"},{"name":"Update - Pending","id":"6b9a33bb-b4a7-411a-87c9-a06b0873a5cd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"⚠This endpoint is currently not available in this version.
\n","urlObject":{"protocol":"https","path":["api","v2","invoice","create_invoice"],"host":["myprocuredesk","com"],"query":[{"disabled":true,"key":"","value":""}],"variable":[]}},"response":[],"_postman_id":"6b9a33bb-b4a7-411a-87c9-a06b0873a5cd"},{"name":"Delete - pending","id":"cc43731c-f043-489b-9077-cb1dae8bae36","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"⚠This endpoint is currently not available in this version.
\n","urlObject":{"protocol":"https","path":["api","v2","po","create_po"],"host":["myprocuredesk","com"],"query":[{"disabled":true,"key":"","value":""}],"variable":[]}},"response":[],"_postman_id":"cc43731c-f043-489b-9077-cb1dae8bae36"},{"name":"Read","id":"8b21ddfb-2b09-46b2-a0cd-ada5a724b38e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"You can retrieve a specific invoice from ProcureDesk using their API, you can utilize the GET /api/v2/invoices endpoint with the id parameter. Here's how to structure your request:
Endpoint:
\nGET https://myprocuredesk.com/api/v2/invoices/?id=1244832\n\nParameters:
\nid: The unique identifier of the invoice you wish to retrieve. In this example, the id is 1244832.Sample Request:
\nGET /api/v2/invoices/?id=1244832\n\nResponse:
A successful request will return a JSON object containing the invoice details. Here's an example of the response structure:
{\n \"success\": true,\n \"result\": {\n \"id\": 1244832,\n \"supplier_invoice_num\": \"INV123456\",\n \"supplier_name\": \"ABC Supplies\",\n \"invoice_date\": \"2024-11-15\",\n \"amount\": \"500.00\",\n \"state\": \"approved\",\n \"line_items\": [\n {\n \"item_description\": \"Office Chairs\",\n \"unit_price\": \"100.00\",\n \"quantity\": \"5\",\n \"total_price\": \"500.00\"\n }\n ]\n // Additional invoice fields...\n }\n}\n\nNote:
Ensure you replace YOUR_ACCESS_TOKEN with your actual API access token. The response will include various fields related to the invoice, such as supplier_invoice_num, supplier_name, invoice_date, amount, state, and line_items. The line_items array provides details about each item included in the invoice.
For more detailed information on ProcureDesk's API and its capabilities, you can refer to their official documentation or contact their support team.
\n","urlObject":{"protocol":"https","path":["api","v2","invoices",""],"host":["myprocuredesk","com"],"query":[{"key":"id","value":"1244832"}],"variable":[]}},"response":[],"_postman_id":"8b21ddfb-2b09-46b2-a0cd-ada5a724b38e"},{"name":"Read All","id":"70ebb2fc-9ba8-4209-9f23-514147a05bcc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Method: GET
Endpoint: /api/v2/invoices
This endpoint retrieves a list of invoices, filtered by parameters such as max_results, modified_date, and status. The response includes detailed information about each invoice, including supplier details, amounts, line items, and associated purchase orders.
GET /api/v2/invoices?max_results=2&modified_date=2024-11-08&status=Approved\n\n{\n \"success\": true,\n \"result\": [\n {\n \"id\": 1244821,\n \"supplier_invoice_num\": \"INV83864684683\",\n \"supplier_name\": null,\n \"invoice_date\": \"2024-11-15\",\n \"received_date\": \"2024-11-13\",\n \"amount\": \"320.0\",\n \"state\": \"approved\",\n \"attachment\": \"Invoice_1288_from_TrueInsight_LLC-241115100458.pdf\",\n \"purchase_order_id\": 481364,\n \"due_date\": \"2024-12-15\",\n \"total_amount\": \"320.0\",\n \"base_currency\": \"ZAR\",\n \"base_currency_rate\": \"1.0\",\n \"base_currency_amount\": \"320.0\",\n \"business_unit\": \"ProcureDesk\",\n \"associated_po_number\": \"PO-2024-30290\",\n \"created_by\": \"Anubhav Srivastava\",\n \"ship_to\": \"LOC VVIP4454, Aguila, AZ, US, 22132\",\n \"line_items\": [\n {\n \"id\": 3863644,\n \"item_no\": \"IT2\",\n \"item_description\": \"dcjduyfcuydfcd\",\n \"unit_price\": \"120.0\",\n \"total_price\": \"120.0\",\n \"quantity\": \"1.0\"\n },\n {\n \"id\": 3863637,\n \"item_no\": \"IT1\",\n \"item_description\": \"kjdguegdieu\",\n \"unit_price\": \"100.0\",\n \"total_price\": \"200.0\",\n \"quantity\": \"2.0\"\n }\n ]\n },\n {\n \"id\": 1241221,\n \"supplier_invoice_num\": \"6t3724rh\",\n \"supplier_name\": null,\n \"invoice_date\": \"2024-11-13\",\n \"received_date\": \"2024-11-13\",\n \"amount\": \"100.0\",\n \"state\": \"approved\",\n \"attachment\": \"mm-67110-Airtel_network-241113142815.pdf\",\n \"purchase_order_id\": 479584,\n \"due_date\": \"2024-12-13\",\n \"total_amount\": \"100.0\",\n \"base_currency\": \"ZAR\",\n \"base_currency_rate\": \"0.05519\",\n \"base_currency_amount\": \"1811.92245\",\n \"business_unit\": \"ProcureDesk\",\n \"associated_po_number\": \"PO-2024-30287\",\n \"created_by\": \"Utkarsh\",\n \"ship_to\": \"K-29 Sector 12, Cincinnati, OH, US, 201301\",\n \"line_items\": [\n {\n \"id\": 3845911,\n \"item_no\": \"IT1\",\n \"item_description\": \"savhb\",\n \"unit_price\": \"100.0\",\n \"total_price\": \"100.0\",\n \"quantity\": \"1.0\"\n }\n ]\n }\n ]\n}\n\nresult (Invoice Details)line_items (Array)Filtering:
\nUse max_results to limit the number of invoices returned per page.
Filter invoices by modified_date or status for more refined results.
Pagination:
\nmax_results, use the next page parameters for additional data.Error Handling:
\nresult array will be returned.Format: Year - Date - Month
\n","type":"text/plain"},"key":"modified_date","value":"2024-11-08"},{"disabled":true,"description":{"content":"Available status: Approved
\n","type":"text/plain"},"key":"status","value":"Approved"}],"variable":[]}},"response":[],"_postman_id":"70ebb2fc-9ba8-4209-9f23-514147a05bcc"}],"id":"58b34316-50b5-4176-9284-b697497ac0fa","description":"The Invoices section of the API documentation provides endpoints for managing invoices within ProcureDesk. It enables users to create, retrieve, update, and manage invoice data seamlessly. These endpoints support features like linking invoices to purchase orders, tracking payment statuses, and ensuring accurate financial records. This section ensures efficient handling of invoice workflows through automation and integration.
\n","_postman_id":"58b34316-50b5-4176-9284-b697497ac0fa"},{"name":"Suppliers","item":[{"name":"Create","id":"a468725d-72ec-49f7-b01c-82aa74bc8db9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Method: POST
Endpoint: /api/v2/suppliers
This endpoint is used to create a new supplier in the system. It allows you to specify key supplier details, including unique identifiers, payment terms, and business associations.
\nsupplier_locations_attributes)This section contains details about the supplier's locations. It is an array of objects, meaning a supplier can have multiple locations.
\nSingle Supplier Location: The supplier currently has only one location in the supplier_locations_attributes array.
Missing Fields: Some fields like default_account_id and country are empty, meaning they may not be required or the data is unavailable.
Draft State: Since the state is \"draft\", this supplier record might still be in the setup phase and not yet finalized for transactions.
po_type is \"Email\", this supplier is configured to receive purchase orders via email.Root Object: supplier
{
\"supplier\": {
\"s_number\": \"Test88889999\",
\"name\": \"NS1122F Test New\",
\"payment_term_id\": 704,
\"payment_method_id\": 159,
\"business_unit\": \"Mobile App\",
\"tax_id_type\": \"EIN\",
\"tax_id\": \"38-1428955\",
\"state\": \"draft\",
\"default_account_id\": \"\",
\"currency\": \"USD\",
\"status\": \"true\",
\"po_type\": \"Email\",
\"supplier_locations_attributes\": [
{
\"loc_type\": \"Purchase\",
\"line_1\": \"test\",
\"line_2\": \"\",
\"city\": \"CHICAGO\",
\"state\": \"IL\",
\"zip_code\": \"545453\",
\"contact_email\": \"test@test.com\",
\"contact_name\": \"Tester\",
\"contact_phone\": \"8787878765\",
\"country\": \"US\"
}
]
}
}
{\n \"success\": true,\n \"result\": {\n \"id\": 16675,\n \"s_number\": \"88889999\",\n \"name\": \"test72722\",\n \"status\": true,\n \"payment_term_id\": 704,\n \"payment_method_id\": 159,\n \"tax_id_type\": \"EIN\",\n \"tax_id\": \"38-1428955\",\n \"dba\": null,\n \"form\": {\n \"url\": \"/assets/svg/boy.svg\",\n \"thumb\": {\n \"url\": \"/assets/svg/boy.svg\"\n },\n \"large\": {\n \"url\": \"/assets/svg/boy.svg\"\n }\n },\n \"currency\": \"USD\",\n \"allow_non_po_invoice\": false,\n \"default_account_id\": null,\n \"state\": \"draft\",\n \"po_type\": \"Email\",\n \"business_unit_id\": 70,\n \"disable_receipt\": null,\n \"internal_contact_id\": null,\n \"track_payments_for_1099\": false,\n \"account_name\": null,\n \"erp_vendor_id\": null,\n \"created_at\": \"2025-02-18T06:05:18.671Z\",\n \"updated_at\": \"2025-02-18T06:05:18.671Z\",\n \"supplier_locations\": [\n {\n \"id\": 16290,\n \"supplier_id\": 16675,\n \"loc_code\": null,\n \"name\": null,\n \"loc_type\": \"Purchase\",\n \"line_1\": \"test\",\n \"line_2\": \"\",\n \"country\": \"US\",\n \"city\": \"CHICAGO\",\n \"state\": \"IL\",\n \"zip_code\": \"60683\",\n \"contact_name\": \"Tester\",\n \"contact_email\": \"test@test.com\",\n \"contact_phone\": \"8787878765\",\n \"is_address_sync\": true\n }\n ]\n }\n}\n\nThis section contains one location object but can have multiple locations.
\nDraft Status: The supplier is still in \"draft\" state, meaning it is not yet active for transactions.
Single Supplier Location: This supplier currently has one location under \"supplier_locations\", but the system allows multiple.
No ERP Linkage: The erp_vendor_id field is null, meaning this supplier is not yet integrated with an ERP system.
No DBA Name: The \"dba\" field is null, indicating that the supplier does not operate under a different business name.
Purchase Orders via Email: \"po_type\": \"Email\" means the supplier prefers receiving POs via email.
Method: PUT
Endpoint: /api/v2/suppliers/{id}
This endpoint updates the details of an existing supplier using the supplier's unique identifier. Fields such as name, payment terms, status, and business unit can be modified.
\nThis section contains one location, but the system allows multiple locations.
\nDraft Status: The supplier is in \"draft\" mode, meaning it is not yet active for transactions.
Active Supplier: Despite being in draft, the \"status\" field is \"true\", indicating that once approved, it will be active.
Single Supplier Location: The supplier currently has one location under \"supplier_locations_attributes\", but additional locations can be added.
POs via Email: The supplier prefers receiving purchase orders through \"Email\".
supplierPUT /api/v2/suppliers/576456\n\n{\n \"supplier\": {\n \"s_number\": \"222\",\n \"name\": \"test\",\n \"payment_term_id\": 704,\n \"payment_method_id\": 159,\n \"business_unit\": \"Mobile App\",\n \"tax_id_type\": \"EIN\",\n \"tax_id\": \"38-1428955\",\n \"state\": \"draft\",\n \"default_account_id\": 0000,\n \"currency\": \"USD\",\n \"status\": \"true\",\n \"po_type\": \"Email\",\n \"supplier_locations_attributes\": [\n {\n \"id\": 16290,\n \"loc_type\": \"Purchase\",\n \"line_1\": \"Test\",\n \"line_2\": \"\",\n \"city\": \"CHICAGO\",\n \"state\": \"IL\",\n \"zip_code\": \"60686\",\n \"contact_email\": \"Tester\",\n \"contact_name\": \"test@test.com\",\n \"contact_phone\": \"8787878765K\",\n \"country\": \"US\"\n }\n ]\n }\n}\n\n{\n \"success\": true,\n \"result\": {\n \"id\": 16675,\n \"s_number\": \"88889999\",\n \"name\": \"test72722\",\n \"status\": true,\n \"payment_term_id\": 704,\n \"payment_method_id\": 159,\n \"tax_id_type\": \"EIN\",\n \"tax_id\": \"38-1428955\",\n \"dba\": null,\n \"form\": {\n \"url\": \"/assets/svg/boy.svg\",\n \"thumb\": {\n \"url\": \"/assets/svg/boy.svg\"\n },\n \"large\": {\n \"url\": \"/assets/svg/boy.svg\"\n }\n },\n \"currency\": \"USD\",\n \"allow_non_po_invoice\": false,\n \"default_account_id\": null,\n \"state\": \"draft\",\n \"po_type\": \"Email\",\n \"business_unit_id\": 70,\n \"disable_receipt\": null,\n \"internal_contact_id\": null,\n \"track_payments_for_1099\": false,\n \"account_name\": null,\n \"erp_vendor_id\": null,\n \"created_at\": \"2025-02-18T06:05:18.671Z\",\n \"updated_at\": \"2025-02-18T06:05:18.671Z\",\n \"supplier_locations\": [\n {\n \"id\": 16290,\n \"supplier_id\": 16675,\n \"loc_code\": null,\n \"name\": null,\n \"loc_type\": \"Purchase\",\n \"line_1\": \"Test\",\n \"line_2\": \"\",\n \"country\": \"US\",\n \"city\": \"CHICAGO\",\n \"state\": \"IL\",\n \"zip_code\": \"60686\",\n \"contact_name\": \"Test\",\n \"contact_email\": \"test@test.com\",\n \"contact_phone\": \"9898987678\",\n \"is_address_sync\": true\n }\n ]\n }\n}\n\nThis section contains one location, but the system allows multiple locations.
\nDraft Status: The supplier is in \"draft\" mode, meaning it is not yet active for transactions.
Active Supplier: Despite being in draft, the \"status\" field is true, meaning the supplier will be active once approved.
No Non-PO Invoices Allowed: The supplier does not allow invoicing without purchase orders.
\nSingle Supplier Location: The supplier has one location but can have more in the future.
\nPOs via Email: The supplier prefers receiving purchase orders through \"Email\".
Tax Information Provided: The supplier has an EIN-based tax ID (\"38-1428955\"), required for financial transactions.
ERP Vendor ID Not Set: The supplier is not yet linked to an ERP system.
\n⚠This endpoint is currently not available in this version.
\n","urlObject":{"protocol":"https","path":["api","v2","suppliers","576456"],"host":["myprocuredesk","com"],"query":[{"disabled":true,"key":"","value":""}],"variable":[]}},"response":[],"_postman_id":"bd64c08b-c576-4c50-b767-78f1847ce22a"},{"name":"Read","id":"3680ccee-a18f-411d-a22d-4921e0c8fc61","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Method: GET
Endpoint: /api/v2/suppliers/{id}
This endpoint retrieves details for a specific supplier using their unique identifier. It provides comprehensive information about the supplier, including their status, payment terms, tax details, and associated business unit.
\nGET /api/v2/suppliers/555479\n\n{\n \"success\": true,\n \"result\": {\n \"id\": 555479,\n \"s_number\": \"1727332803\",\n \"name\": \"Test 37884\",\n \"status\": true,\n \"payment_term_id\": 1,\n \"payment_method_id\": 1,\n \"tax_id_type\": \"EIN\",\n \"tax_id\": \"\",\n \"dba\": \"\",\n \"form\": {\n \"url\": \"/assets/svg/boy.svg\",\n \"thumb\": {\n \"url\": \"/assets/svg/boy.svg\"\n },\n \"large\": {\n \"url\": \"/assets/svg/boy.svg\"\n }\n },\n \"currency\": null,\n \"allow_non_po_invoice\": false,\n \"default_account_id\": 144924,\n \"state\": \"approved\",\n \"po_type\": \"Email\",\n \"business_unit_id\": 1,\n \"disable_receipt\": false,\n \"internal_contact_id\": null,\n \"track_payments_for_1099\": false,\n \"account_name\": \"\",\n \"erp_vendor_id\": null,\n \"created_at\": \"2024-09-26T06:40:03.040Z\",\n \"updated_at\": \"2024-09-26T06:40:24.305Z\"\n }\n}\n\nresultURL Parameter:
\n{id} in the endpoint must be replaced with the unique supplier ID to retrieve the correct details.Response Structure:
\nThe response includes metadata about the supplier, such as tax ID, payment terms, and associated business units.
\nThe form object provides URLs for any documents associated with the supplier.
Error Handling:
\nAuthorization:
\nMethod: GET
Endpoint: /api/v2/suppliers
This endpoint retrieves a paginated list of all suppliers. It includes detailed information about each supplier, such as their tax details, status, payment terms, and associated business units.
\nGET /api/v2/suppliers?max_results=3&modified_date=&page=1\n\n{\n \"success\": true,\n \"result\": [\n {\n \"id\": 16675,\n \"s_number\": \"88889999\",\n \"name\": \"test72722\",\n \"status\": true,\n \"payment_term_id\": 704,\n \"payment_method_id\": 159,\n \"tax_id_type\": \"EIN\",\n \"tax_id\": \"38-1428955\",\n \"dba\": null,\n \"form\": {\n \"url\": \"/assets/svg/boy.svg\",\n \"thumb\": {\n \"url\": \"/assets/svg/boy.svg\"\n },\n \"large\": {\n \"url\": \"/assets/svg/boy.svg\"\n }\n },\n \"currency\": \"USD\",\n \"allow_non_po_invoice\": false,\n \"default_account_id\": null,\n \"state\": \"draft\",\n \"po_type\": \"Email\",\n \"business_unit_id\": 70,\n \"disable_receipt\": null,\n \"internal_contact_id\": null,\n \"track_payments_for_1099\": false,\n \"account_name\": null,\n \"erp_vendor_id\": null,\n \"created_at\": \"2025-02-18T06:05:18.671Z\",\n \"updated_at\": \"2025-02-18T06:05:18.671Z\",\n \"supplier_locations\": [\n {\n \"id\": 16290,\n \"supplier_id\": 16675,\n \"loc_code\": null,\n \"name\": null,\n \"loc_type\": \"Purchase\",\n \"line_1\": \"Test\",\n \"line_2\": \"\",\n \"country\": \"US\",\n \"city\": \"CHICAGO\",\n \"state\": \"IL\",\n \"zip_code\": \"60686\",\n \"contact_name\": \"Tester\",\n \"contact_email\": \"test@test.com\",\n \"contact_phone\": \"8787878765\",\n \"is_address_sync\": true\n }\n ]\n }\n\nform: Includes links to image assets for the supplier's visual representation (likely a logo), with different sizes for different uses.
currency: Specifies the currency used for transactions (USD).
allow_non_po_invoice: States whether invoices are allowed without a corresponding purchase order (false means not allowed).
Supplier Location: Includes the address, contact info, and other details for the supplier’s specific location.
\nstate: Indicates whether the supplier is in a \"draft\" or \"active\" state. \"Draft\" may indicate it's in an unfinalized state.
The Suppliers API allows users to manage supplier information within the system, providing endpoints to create, update, retrieve, and delete supplier records. Through this API, users can access supplier details like name, contact information, address, tax ID, and other relevant data to ensure accurate procurement and payment processes.
\nGET /suppliers: Retrieve a list of all suppliers, with optional filters for searching by name, status, or category.
\nGET /suppliers/{id}: Retrieve detailed information about a specific supplier by supplier ID.
\nPOST /suppliers: Create a new supplier record, including mandatory fields such as name, address, and contact details.
\nPUT /suppliers/{id}: Update an existing supplier's details by supplier ID.
\nMethod: POST
Endpoint: /api/v2/job_projects
This endpoint is used to create a new job project, including its associated budget lines. It allows the specification of project details such as name, description, owner, start and end dates, and budget line allocations.
\njob_projectbudget_lines_attributes (Array Item){\n \"job_project\": {\n \"name\": \"Construction for the new office\",\n \"description\": \"Construction for the new office\",\n \"owner_id\": \"4\",\n \"start_date\": \"2024-11-09\",\n \"end_date\": \"2025-11-09\",\n \"budget_lines_attributes\": [\n {\n \"description\": \"Materials\",\n \"budgeted_amount\": \"5000\",\n \"start_date\": \"2024-11-09\",\n \"end_date\": \"2025-11-09\"\n },\n {\n \"description\": \"Services\",\n \"budgeted_amount\": \"5000\",\n \"start_date\": \"2024-11-09\",\n \"end_date\": \"2025-11-09\"\n }\n ]\n }\n}\n\n{\n \"success\": true,\n \"result\": \"Job Project created / updated successfully\"\n}\n\nValidation:
\nAll mandatory fields in the job_project and budget_lines_attributes objects must be provided.
The start_date must be earlier than or equal to the end_date.
Error Handling:
\nAuthorization:
\nBudget Lines:
\nMethod: PUT
Endpoint: /api/v2/job_projects/{id}
This endpoint updates the details of an existing job project using the project’s unique identifier. It allows you to modify project details, such as name, description, owner, dates, and associated budget lines.
\njob_projectbudget_lines_attributes (Array Item)PUT /api/v2/job_projects/12345\n\n{\n \"job_project\": {\n \"name\": \"Construction for the new office\",\n \"description\": \"Construction for the new office\",\n \"owner_id\": \"4\",\n \"start_date\": \"2024-11-09\",\n \"end_date\": \"2025-11-09\",\n \"budget_lines_attributes\": [\n {\n \"description\": \"Materials\",\n \"budgeted_amount\": \"5000\",\n \"start_date\": \"2024-11-09\",\n \"end_date\": \"2025-11-09\"\n },\n {\n \"description\": \"Services\",\n \"budgeted_amount\": \"6000\",\n \"start_date\": \"2024-11-09\",\n \"end_date\": \"2025-11-09\"\n }\n ]\n }\n}\n\n{\n \"success\": true,\n \"result\": \"Job Project created / updated successfully\"\n}\n\nValidation:
\nThe {id} in the URL must match the ID of an existing job project.
All mandatory fields in the job_project and budget_lines_attributes objects must be provided.
The start_date must be earlier than or equal to the end_date.
Error Handling:
\nMissing or invalid fields will result in a descriptive error response.
\nIf the project ID does not exist, the API will return an error message.
\nAuthorization:
\nBudget Lines:
\n⚠This endpoint is currently not available in this version.
\n","urlObject":{"protocol":"https","path":["api","v2","po","create_po"],"host":["myprocuredesk","com"],"query":[{"disabled":true,"key":"","value":""}],"variable":[]}},"response":[],"_postman_id":"c1b8fa28-54ab-459e-b366-141c81925884"},{"name":"Read - Not Implemented","id":"1e169c59-85e7-498b-9abc-4bc8586c0b60","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"⚠This endpoint is currently not available in this version.
\n","urlObject":{"protocol":"https","path":["api","v2","job_projects"],"host":["myprocuredesk","com"],"query":[{"disabled":true,"key":"","value":""},{"disabled":true,"key":"","value":""}],"variable":[]}},"response":[],"_postman_id":"1e169c59-85e7-498b-9abc-4bc8586c0b60"},{"name":"Read All","id":"503e10ef-2ab5-43dd-84dd-be50aecb5677","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Method: GET
Endpoint: /api/v2/job_projects
This endpoint retrieves a paginated list of all job projects. It allows optional filtering and customization of the number of results per page.
\nGET /api/v2/job_projects?max_results=2&page=1\n\n{\n \"success\": true,\n \"result\": [\n {\n \"id\": 1001,\n \"name\": \"Construction for the new office\",\n \"description\": \"Office expansion project\",\n \"owner_id\": 4,\n \"start_date\": \"2024-11-09\",\n \"end_date\": \"2025-11-09\",\n \"state\": \"active\",\n \"budget_lines\": [\n {\n \"id\": 2001,\n \"description\": \"Materials\",\n \"budgeted_amount\": \"5000\",\n \"start_date\": \"2024-11-09\",\n \"end_date\": \"2025-11-09\"\n },\n {\n \"id\": 2002,\n \"description\": \"Services\",\n \"budgeted_amount\": \"6000\",\n \"start_date\": \"2024-11-09\",\n \"end_date\": \"2025-11-09\"\n }\n ]\n },\n {\n \"id\": 1002,\n \"name\": \"Marketing Campaign 2024\",\n \"description\": \"Annual marketing initiatives\",\n \"owner_id\": 5,\n \"start_date\": \"2024-01-01\",\n \"end_date\": \"2024-12-31\",\n \"state\": \"completed\",\n \"budget_lines\": [\n {\n \"id\": 3001,\n \"description\": \"Digital Ads\",\n \"budgeted_amount\": \"10000\",\n \"start_date\": \"2024-01-01\",\n \"end_date\": \"2024-12-31\"\n }\n ]\n }\n ],\n \"pagination\": {\n \"current_page\": 1,\n \"max_results\": 2,\n \"total_pages\": 5,\n \"total_results\": 10\n }\n}\n\nresult (Array Item)budget_lines (Array Item)paginationQuery Parameters:
\nUse max_results to control the number of job projects returned per page.
Use page to navigate through paginated results.
Response Structure:
\nError Handling:
\nresult array will be returned.Authorization:
\nThe Job Projects API is designed to manage and track projects within your organization. It allows users to create, update, retrieve, and manage detailed project information, including budgets, timelines, and ownership. This API is especially useful for organizations that need to oversee multiple projects, allocate budgets, and ensure alignment with business objectives.
\nProject Creation:
\nBudget Allocation:
\nProject Management:
\nRetrieve Project Details:
\nList All Projects:
\nMethod: POST
Endpoint: /api/v2/catalogs
This endpoint is used to create a new catalog in the system. Catalogs are used to organize and manage items, making it easier to track and source them for procurement processes.
\ncatalog{\n \"catalog\": {\n \"name\": \"Supplies for office\",\n \"description\": \"Catalog for supplies\",\n \"status\": true,\n \"is_sync\": false,\n \"customer_catalog\": false\n }\n}\n\n{\n \"status\": true,\n \"catalog_id\": 2134\n}\n\nValidation:
\nThe name and description fields are mandatory and must be unique across catalogs.
The status field determines whether the catalog will be immediately active.
Optional Fields:
\nis_sync is set to true, ensure the system is configured to handle external synchronization.Error Handling:
\nMissing mandatory fields will result in a validation error response.
\nIf the catalog name already exists, the API will return an error.
\nAuthorization:
\n⚠This endpoint is currently not available in this version.
\n","urlObject":{"protocol":"https","path":["api","v2","catalogs","2134"],"host":["myprocuredesk","com"],"query":[{"disabled":true,"key":"","value":""}],"variable":[]}},"response":[],"_postman_id":"0620f046-dae9-4ef6-8d2b-87657a1f5358"},{"name":"Delete - Pending","id":"561da8f4-f3ca-4bee-ab97-39a3315a3f4b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"⚠This endpoint is currently not available in this version.
\n","urlObject":{"protocol":"https","path":["api","v2","catalogs"],"host":["myprocuredesk","com"],"query":[{"disabled":true,"key":"","value":""}],"variable":[]}},"response":[],"_postman_id":"561da8f4-f3ca-4bee-ab97-39a3315a3f4b"},{"name":"Read All","id":"ab4f5aa6-dc12-4f10-8665-43cb0666b13e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Method: GET
Endpoint: /api/v2/catalogs
This endpoint retrieves a paginated list of all catalogs available in the system. It provides detailed information about each catalog, including its name, description, status, and creation date.
\nGET /api/v2/catalogs?max_results=2&page=1\n\n[\n {\n \"id\": 2134,\n \"company_id\": 1,\n \"name\": \"Supplies for new office\",\n \"description\": \"Catalog for new supplies\",\n \"status\": true,\n \"created_at\": \"2024-11-16T16:25:38.590Z\",\n \"customer_catalog\": false,\n \"is_sync\": false,\n \"business_unit_id\": 1\n },\n {\n \"id\": 2113,\n \"company_id\": 1,\n \"name\": \"Supplies for office\",\n \"description\": \"Catalog for supplies\",\n \"status\": true,\n \"created_at\": \"2024-11-09T16:16:23.238Z\",\n \"customer_catalog\": false,\n \"is_sync\": false,\n \"business_unit_id\": 1\n }\n]\n\nQuery Parameters:
\nUse max_results to control the number of catalogs returned per page.
Use page to navigate through paginated results.
Response Structure:
\nError Handling:
\nAuthorization:
\nCatalogs serve as a centralized repository for organizing and managing items within the procurement system. They provide an easy way to group related products, services, or resources, ensuring a streamlined and efficient sourcing process. By leveraging catalogs, businesses can standardize their procurement activities, maintain consistency, and simplify the purchasing experience for users.
\n","_postman_id":"e0169f03-7dfe-46b0-be65-de8f75eed719"},{"name":"Catalog Lines","item":[{"name":"Get Items by Catalog","id":"2de086f8-ed90-40bb-bba8-c189fd14a366","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Method: GET
Endpoint: /api/v2/catalogs/{catalog_id}/items_by_catalog
This endpoint retrieves a list of items within a specified catalog. It provides detailed information about each item, including pricing, description, supplier information, and inventory details.
\nGET /api/v2/catalogs/2113/items_by_catalog\n\n{\n \"success\": true,\n \"result\": [\n {\n \"id\": 680741,\n \"catalog_id\": 2113,\n \"item_no\": \"456\",\n \"item_name\": \"Laptop1\",\n \"item_description\": \"Laptop for the main office 20GB RAM\",\n \"supplier_id\": 746,\n \"price\": \"53.0\",\n \"account_name\": \"Office Supplies\",\n \"status\": true,\n \"preferred_item\": true,\n \"uom_master_id\": 1,\n \"created_at\": \"2024-11-13T01:27:06.242Z\",\n \"updated_at\": \"2024-11-13T01:27:06.242Z\"\n },\n {\n \"id\": 677815,\n \"catalog_id\": 2113,\n \"item_no\": \"123\",\n \"item_name\": \"Laptop1\",\n \"item_description\": \"Laptop for the main office 20GB RAM\",\n \"supplier_id\": null,\n \"price\": null,\n \"account_name\": \"Office Supplies\",\n \"status\": true,\n \"preferred_item\": true,\n \"uom_master_id\": 1,\n \"created_at\": \"2024-11-09T21:59:05.069Z\",\n \"updated_at\": \"2024-11-09T22:00:00.324Z\"\n }\n ]\n}\n\nresult (Array Item)Filtering and Sorting:
\nstatus field.Error Handling:
\ncatalog_id does not exist, the API will return an error message.Usage:
\nPOST /api/line_item
This API is used to create a new line item in the system, which typically represents an individual product or service that will be managed within an inventory or procurement system.
\nContent-Type: application/json
Authorization: Bearer (if authentication is required)
{\n \"line_item\": {\n \"item_no\": \"0071-009\",\n \"item_name\": \"Test-0900\",\n \"item_description\": \"Tester\",\n \"mfr_name\": \"abc2\",\n \"mfr_no\": \"xyz\",\n \"category_id\": \"314\",\n \"hierarchy_value_id\": \"448\",\n \"uom_master_id\": \"598\",\n \"item_type\": \"non_inventory\",\n \"moq\": 12,\n \"vendor_items_attributes\": [\n {\n \"supplier_name\": \"GBP - TEST6868\",\n \"supplier_item_no\": \"11221\",\n \"list_price\": 510,\n \"preferred\": true\n },\n {\n \"supplier_name\": \"FRIZZIE Corp (DTS)\",\n \"supplier_item_no\": \"111221\",\n \"list_price\": 5110,\n \"preferred\": false\n }\n ],\n \"class_master_id\": \"88\"\n }\n}\n\n{\n \"success\": true,\n \"result\": {\n \"id\": 30774,\n \"catalog_id\": 162,\n \"item_no\": \"0071-009\",\n \"item_name\": \"james bond1-0900\",\n \"item_description\": \"james bond indian1\",\n \"supplier_id\": 16318,\n \"supplier_item_no\": null,\n \"mfr_name\": \"abc2\",\n \"mfr_no\": \"xyz\",\n \"list_price\": \"0.0\",\n \"price\": \"510.0\",\n \"lead_time\": null,\n \"item_type\": \"non_inventory\",\n \"moq\": \"12\",\n \"image_url\": null,\n \"category_id\": 314,\n \"account_name\": \"JOM\",\n \"account_id\": 448,\n \"unspsc_id\": null,\n \"status\": true,\n \"preferred_item\": true,\n \"created_at\": \"2025-02-18T06:45:17.864Z\",\n \"updated_at\": \"2025-02-18T06:45:17.864Z\",\n \"uom_master_id\": 598,\n \"hierarchy_value_id\": 448,\n \"markup_percentage\": \"0.0\",\n \"product_bundle_id\": null,\n \"parent_item\": false,\n \"total_price\": \"0.0\",\n \"txn_id\": null,\n \"sync_token\": 0,\n \"class_master_id\": 88,\n \"item_status\": true,\n \"is_sell\": false,\n \"sales_description\": null,\n \"sales_price\": \"0.0\",\n \"income_account_id\": null,\n \"inventory_location\": null,\n \"vendor_items\": [\n {\n \"id\": 30618,\n \"line_item_id\": 30774,\n \"supplier_id\": 16318,\n \"list_price\": \"510.0\",\n \"supplier_item_no\": \"11221\",\n \"preferred\": true\n },\n {\n \"id\": 30619,\n \"line_item_id\": 30774,\n \"supplier_id\": 570,\n \"list_price\": \"5110.0\",\n \"supplier_item_no\": \"111221\",\n \"preferred\": false\n }\n ]\n }\n}\n\nExplaination :
\nHere's an explanation of the data in table format:
\nThis API allows you to update the details of an existing line item, including its attributes (like item name, description, vendor details, etc.).
\n{\n \"line_item\": {\n \"item_no\": \"8899-121\",\n \"item_name\": \"West Coast P--new-2323\",\n \"item_description\": \"Supplier Name 69-1112\",\n \"mfr_name\": \"abc2\",\n \"mfr_number\": \"xyz\",\n \"category_id\": \"314\",\n \"account_name\": \"JOM\",\n \"uom_master_id\": \"598\",\n \"item_type\": \"non_inventory\",\n \"moq\": 12,\n \"vendor_items_attributes\": [\n {\n \"id\": 30583,\n \"supplier_name\": \"GBP - TEST6868\",\n \"supplier_item_no\": \"11221\",\n \"list_price\": 510,\n \"preferred\": true\n },\n {\n \"id\": 30584,\n \"supplier_name\": \"FRIZZIE Corp (DTS)\",\n \"supplier_item_no\": \"111221\",\n \"list_price\": 5110,\n \"preferred\": false\n }\n ],\n \"class_master_id\": \"88\"\n }\n}\n\nThis record represents a specific vendor item with its details, such as the supplier's ID, item number, pricing, and whether the supplier is preferred.
\nThe line_item_id links this vendor item to a specific line item in the catalog or inventory system.
The preferred field indicates whether the supplier is the preferred choice for this particular item, and in this case, it is marked as false, meaning it is not preferred.
{\n \"line_item\": {\n \"item_no\": \"8899-121\",\n \"item_name\": \"West Coast P--new-2323\",\n \"item_description\": \"Supplier Name 69-1112\",\n \"mfr_name\": \"abc2\",\n \"mfr_number\": \"xyz\",\n \"category_id\": \"314\",\n \"account_name\": \"JOM\",\n \"uom_master_id\": \"598\",\n \"item_type\": \"non_inventory\",\n \"moq\": 12,\n \"vendor_items_attributes\": [\n {\n \"id\": 30583,\n \"supplier_name\": \"GBP - TEST6868\",\n \"supplier_item_no\": \"11221\",\n \"list_price\": 510,\n \"preferred\": true\n },\n {\n \"id\": 30584,\n \"supplier_name\": \"FRIZZIE Corp (DTS)\",\n \"supplier_item_no\": \"111221\",\n \"list_price\": 5110,\n \"preferred\": false\n }\n ],\n \"class_master_id\": \"88\"\n }\n}\n\n{\n \"success\": true,\n \"result\": {\n \"id\": 30747,\n \"catalog_id\": 162,\n \"item_no\": \"8899-121\",\n \"item_name\": \"West Coast P--new-2323\",\n \"item_description\": \"Supplier Name 69-1112\",\n \"supplier_id\": 16318,\n \"supplier_item_no\": null,\n \"mfr_name\": \"abc2\",\n \"mfr_no\": null,\n \"list_price\": \"0.0\",\n \"price\": \"510.0\",\n \"lead_time\": null,\n \"item_type\": \"non_inventory\",\n \"moq\": \"12\",\n \"image_url\": null,\n \"category_id\": 314,\n \"account_name\": null,\n \"account_id\": null,\n \"unspsc_id\": null,\n \"status\": true,\n \"preferred_item\": true,\n \"created_at\": \"2025-01-27T20:01:55.732Z\",\n \"updated_at\": \"2025-02-17T09:11:50.897Z\",\n \"uom_master_id\": 598,\n \"hierarchy_value_id\": null,\n \"markup_percentage\": \"0.0\",\n \"product_bundle_id\": null,\n \"parent_item\": false,\n \"total_price\": \"0.0\",\n \"txn_id\": null,\n \"sync_token\": 0,\n \"class_master_id\": 88,\n \"item_status\": true,\n \"is_sell\": false,\n \"sales_description\": null,\n \"sales_price\": \"0.0\",\n \"income_account_id\": null,\n \"inventory_location\": null,\n \"vendor_items\": [\n {\n \"id\": 30583,\n \"line_item_id\": 30747,\n \"supplier_id\": 16318,\n \"list_price\": \"510.0\",\n \"supplier_item_no\": \"11221\",\n \"preferred\": true\n },\n {\n \"id\": 30584,\n \"line_item_id\": 30747,\n \"supplier_id\": 570,\n \"list_price\": \"5110.0\",\n \"supplier_item_no\": \"111221\",\n \"preferred\": false\n }\n ]\n }\n}\n\nExplanation:
Here’s a table format breakdown for the provided data along with explanations:
We can use this API to get a single item response
\nGET /catalogs/{catalog_id}/line_items/{id}
\nThis endpoint retrieves a specific line item from the catalog identified by {catalog_id}.
\nNo request body is required for this endpoint.
\nThe response will be a JSON object with the following schema:
\n{\n \"type\": \"object\",\n \"properties\": {\n \"id\": {\"type\": \"number\"},\n \"catalog_id\": {\"type\": \"number\"},\n \"item_no\": {\"type\": \"string\"},\n \"item_name\": {\"type\": \"string\"},\n \"item_description\": {\"type\": \"string\"},\n \"supplier_id\": {\"type\": \"number\"},\n \"supplier_item_no\": {\"type\": [\"string\", \"null\"]},\n \"mfr_name\": {\"type\": [\"string\", \"null\"]},\n \"mfr_no\": {\"type\": [\"string\", \"null\"]},\n \"list_price\": {\"type\": \"string\"},\n \"price\": {\"type\": \"string\"},\n \"lead_time\": {\"type\": [\"string\", \"null\"]},\n \"item_type\": {\"type\": \"string\"},\n \"moq\": {\"type\": \"string\"},\n \"image_url\": {\"type\": [\"string\", \"null\"]},\n \"category_id\": {\"type\": \"number\"},\n \"account_name\": {\"type\": [\"string\", \"null\"]},\n \"account_id\": {\"type\": [\"string\", \"null\"]},\n \"unspsc_id\": {\"type\": [\"string\", \"null\"]},\n \"status\": {\"type\": \"boolean\"},\n \"preferred_item\": {\"type\": \"boolean\"},\n \"created_at\": {\"type\": \"string\", \"format\": \"date-time\"},\n \"updated_at\": {\"type\": \"string\", \"format\": \"date-time\"},\n \"uom_master_id\": {\"type\": \"number\"},\n \"hierarchy_value_id\": {\"type\": [\"number\", \"null\"]},\n \"markup_percentage\": {\"type\": \"string\"},\n \"product_bundle_id\": {\"type\": [\"number\", \"null\"]},\n \"parent_item\": {\"type\": \"boolean\"},\n \"total_price\": {\"type\": \"string\"},\n \"txn_id\": {\"type\": [\"string\", \"null\"]},\n \"sync_token\": {\"type\": \"number\"},\n \"class_master_id\": {\"type\": \"number\"},\n \"item_status\": {\"type\": \"boolean\"},\n \"is_sell\": {\"type\": \"boolean\"},\n \"sales_description\": {\"type\": [\"string\", \"null\"]},\n \"sales_price\": {\"type\": \"string\"},\n \"income_account_id\": {\"type\": [\"string\", \"null\"]},\n \"inventory_location\": {\"type\": [\"string\", \"null\"]},\n \"vendor_items\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"id\": {\"type\": \"number\"},\n \"line_item_id\": {\"type\": \"number\"},\n \"supplier_id\": {\"type\": \"number\"},\n \"list_price\": {\"type\": \"string\"},\n \"supplier_item_no\": {\"type\": [\"string\", \"null\"]},\n \"preferred\": {\"type\": \"boolean\"}\n }\n }\n }\n }\n}\n\nMethod: GET Explanation: Here’s the data you provided in a table format with explanations for each field:
jsonCopyEdit{\n \"success\": true,\n \"result\": {\n \"id\": 30768,\n \"catalog_id\": 162,\n \"item_no\": \"8899\",\n \"item_name\": \"Test\",\n \"item_description\": \"Tester\",\n \"supplier_id\": 16318,\n \"supplier_item_no\": null,\n \"mfr_name\": \"abc2\",\n \"mfr_no\": null,\n \"list_price\": \"0.0\",\n \"price\": \"510.0\",\n \"lead_time\": null,\n \"item_type\": \"non_inventory\",\n \"moq\": \"12\",\n \"image_url\": null,\n \"category_id\": 314,\n \"account_name\": null,\n \"account_id\": null,\n \"unspsc_id\": null,\n \"status\": true,\n \"preferred_item\": true,\n \"created_at\": \"2025-02-17T08:59:29.989Z\",\n \"updated_at\": \"2025-02-17T08:59:29.989Z\",\n \"uom_master_id\": 598,\n \"hierarchy_value_id\": null,\n \"markup_percentage\": \"0.0\",\n \"product_bundle_id\": null,\n \"parent_item\": false,\n \"total_price\": \"0.0\",\n \"txn_id\": null,\n \"sync_token\": 0,\n \"class_master_id\": 88,\n \"item_status\": true,\n \"is_sell\": false,\n \"sales_description\": null,\n \"sales_price\": \"0.0\",\n \"income_account_id\": null,\n \"inventory_location\": null,\n \"vendor_items\": [\n {\n \"id\": 30608,\n \"line_item_id\": 30768,\n \"supplier_id\": 16318,\n \"list_price\": \"510.0\",\n \"supplier_item_no\": \"11221\",\n \"preferred\": true\n },\n {\n \"id\": 30609,\n \"line_item_id\": 30768,\n \"supplier_id\": 570,\n \"list_price\": \"5110.0\",\n \"supplier_item_no\": \"111221\",\n \"preferred\": false\n }\n ]\n }\n}\n\nMethod: DELETE
Endpoint: /api/v2/catalogs/{catalog_id}/line_items/{line_item_id}
This endpoint allows you to delete a specific line item from a specified catalog. Deleting a line item removes it permanently from the catalog.
\nDELETE /api/v2/catalogs/2113/line_items/677814\n\n{\n \"success\": true,\n \"message\": \"Line item deleted successfully.\"\n}\n\nValidation:
\ncatalog_id and line_item_id are valid and correspond to an existing catalog and line item.Error Handling:
\nline_item_id does not exist or belongs to another catalog, the API will return an error message.Authorization:
\nPermanent Deletion:
\nMethod: GET
Endpoint: /api/v2/catalogs/{catalog_id}/line_items/{line_item_id}
This endpoint retrieves detailed information about a specific line item from a specified catalog. The response includes item details, pricing, supplier information, and associated accounts.
\nGET /api/v2/catalogs/2113/line_items/680741\n\n{\n \"success\": true,\n \"result\": {\n \"id\": 680741,\n \"catalog_id\": 2113,\n \"item_no\": \"456\",\n \"item_name\": \"Laptop1\",\n \"item_description\": \"Laptop for the main office 20GB RAM\",\n \"supplier_id\": 746,\n \"supplier_item_no\": null,\n \"mfr_name\": null,\n \"mfr_no\": null,\n \"list_price\": \"0.0\",\n \"price\": \"53.0\",\n \"lead_time\": null,\n \"item_type\": \"non_inventory\",\n \"moq\": null,\n \"image_url\": null,\n \"category_id\": null,\n \"account_name\": \"Office Supplies\",\n \"account_id\": 3,\n \"unspsc_id\": null,\n \"status\": true,\n \"preferred_item\": true,\n \"created_at\": \"2024-11-13T01:27:06.242Z\",\n \"updated_at\": \"2024-11-13T01:27:06.242Z\",\n \"uom_master_id\": 1,\n \"hierarchy_value_id\": 3,\n \"markup_percentage\": \"0.0\",\n \"product_bundle_id\": null,\n \"parent_item\": false,\n \"total_price\": \"0.0\",\n \"txn_id\": null,\n \"sync_token\": 0,\n \"class_master_id\": null,\n \"item_status\": true,\n \"is_sell\": false,\n \"sales_description\": null,\n \"sales_price\": \"0.0\",\n \"income_account_id\": null,\n \"inventory_location\": null\n }\n}\n\nresult (Line Item Details)Usage:
\nError Handling:
\ncatalog_id or line_item_id does not exist, the API will return an error message.Authorization:
\nCatalog Lines represent individual items or entries within a catalog. They detail specific products, services, or resources that can be sourced or purchased. Catalog lines are the building blocks of catalogs, providing granular information about each item, such as name, description, pricing, and availability.
\n","_postman_id":"6467137c-baa7-4c42-8fe9-d1a8a0ce303c"},{"name":"Inventory","item":[{"name":"On Hand Details","id":"8f17ad84-5985-4e70-9506-1222f12f0c72","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Method:GET
Endpoint: /api/v2/inventories/{inventory_id}/inventory_locations/{inventory_location_id}/on_hand_details
Sample Request:https://myprocuredesk.com/api/v2/inventories/1552/inventory_locations/44/on_hand_details
Sample Response
\n{{\n \"status\": true,\n \"result\": {\n \"location_name\": \"Mumbai\",\n \"on_hand_details\": [\n {\n \"on_hand_location_id\": 587,\n \"item_no\": \"1\",\n \"receipt_number\": \"30000063\",\n \"received_on\": \"02/28/2025\",\n \"on_hand\": 114,\n \"inventory_value\": \"$22,800.00\",\n \"unit_price\": \"$200.00\"\n },\n {\n \"on_hand_location_id\": 162,\n \"item_no\": \"1\",\n \"receipt_number\": \"30000052\",\n \"received_on\": \"01/15/2025\",\n \"on_hand\": 0,\n \"inventory_value\": \"$0.00\",\n \"unit_price\": \"$1,000.00\"\n }\n ]\n }\n}\n\nMethod:POST
Endpoint:/api/v2/inventories/1552/returns**_*Request Payload
{\n \"inventory\": {\n \"return_attributes\": {\n \"return_date\": \"2025-10-14\",\n \"return_reason\": \"Tsting\",\n \"return_from_id\": \"1084\",\n \"inventory_return_items_attributes\": [\n {\n \"quantity\": 5,\n \"inventory_location_id\": \"44\",\n \"default_account_id\": \"2111\"\n }\n ]\n }\n }\n}\n\nRequest Body Structure
\nSample Request:https://myprocuredesk.com/api/v2/inventories/1552/returns
Sample Response
\n{\n \"status\": true,\n \"result\": {\n \"return_detail\": {\n \"created_by\": {\n \"id\": 1084,\n \"name\": \"Approver User\"\n },\n \"return_from\": {\n \"id\": 1084,\n \"name\": \"Approver User\"\n },\n \"return_date\": \"03/06/2025\",\n \"return_reason\": \"\",\n \"return_items\": [\n {\n \"id\": 159,\n \"return_quantity\": 5.0,\n \"inventory_location\": {\n \"id\": 44,\n \"name\": \"Mumbai\"\n },\n \"inventory_account_detail\": {\n \"account_id\": 2111,\n \"account_name\": \"Test\"\n }\n }\n ],\n \"created_at\": \"03/06/2025\",\n \"updated_at\": \"03/06/2025\"\n }\n }\n}\n\nresult.release_detail)return_detail.return_items Array)Method:POST
Endpoint:/api/v2/inventories/{inventory_id}/releases
Request Payload Structure:
\n{\n \"inventory\": {\n \"release_attributes\": {\n \"date\": \"2025-10-14\",\n \"shipping_information\": \"Tsting\",\n \"notes\": \"Test\",\n \"release_to_id\": \"1084\",\n \"project_code_id\": \"\",\n \"release_items_attributes\": [\n {\n \"released_quantity\": 5,\n \"inventory_location_id\": \"44\",\n \"default_account_id\": \"2110\"\n }\n ]\n }\n }\n}\n\nPayload Structure in Table Format:
\nSample Request:https://myprocuredesk.com/api/v2/inventories/1552/releases
Sample Response:
\n{\n \"status\": true,\n \"result\": {\n \"release_detail\": {\n \"releasor\": {\n \"id\": 1084,\n \"name\": \"Approver User\"\n },\n \"release_to\": {\n \"id\": 1084,\n \"name\": \"Approver User\"\n },\n \"project_code\": \"\",\n \"date\": \"10/14/2025\",\n \"notes\": \"Test\",\n \"shipping_information\": \"Tsting\",\n \"release_items\": [\n {\n \"id\": 636,\n \"released_quantity\": 5,\n \"inventory_location\": {\n \"id\": 44,\n \"name\": \"Mumbai\"\n },\n \"inventory_account_detail\": {\n \"account_id\": 2110,\n \"account_name\": \"Lopesh\"\n }\n }\n ],\n \"created_at\": \"03/06/2025\",\n \"updated_at\": \"03/06/2025\"\n }\n }\n}\n\nresult.release_detail)release_items Array)This endpoint allows you to add on-hand inventory details to the system.
\nThe request body should be in JSON format and include the following parameters:
\ninventory_id (integer): The unique identifier for the inventory item you are adding.
\ninventory_location (array of objects): A list of locations where the inventory is stored. Each object in the array should contain:
\nid (integer): The unique identifier for the inventory location.
\non_hand (integer): The quantity of the inventory item that is currently on hand at the specified location.
\nunit_price (float): The price per unit of the inventory item.
\n{\n \"inventory_id\": 40,\n \"inventory_location\": [\n {\n \"id\": 46,\n \"on_hand\": 100,\n \"unit_price\": 25.5\n }\n ]\n}\n\nUpon successful addition of the inventory, the API will return a confirmation response indicating the status of the operation. The response will typically include a success message and may also return the details of the added inventory item.
\n{\n \"status\": true,\n \"message\": \"Inventory on hand created successfully\",\n \"records_created\": 3\n}\n\nEnsure that the inventory_id and inventory_location details are accurate to avoid errors during the addition process.
This endpoint may require appropriate authentication headers to be included in the request.
\nThis HTTP PUT request is used to update the on-hand quantity of items in a specified inventory location.
\nPurpose:
To modify the available quantity of a specific item at a given inventory location.
Endpoint:/api/v2/inventories/{item_number}/update_on_hand
Payload Body Structure:
\n{\n \"inventory_location\": [\n {\n \"id\": \"120\",\n \"on_hand\": \"123\"\n }\n ]\n}\n\nSample Request:https://myprocuredesk.com/api/v2/inventories/1552/update_on_hand
Sample Response:
\n{\n \"status\": true,\n \"message\": \"Inventory on hand updated Successfully\"\n}\n\nMethod:GET
Endpoint:/api/v2/inventories/{inventory_id}/lot_trackings
Sample Request:/api/v2/inventories/{inventory_id}/lot_trackings
Sample Response
\n{\n \"status\": true,\n \"result\": [\n {\n \"id\": 146,\n \"receipt_number\": \"30000052\",\n \"lot_number\": \"d\",\n \"received_quantity\": 3,\n \"received_on\": \"01/15/2025\",\n \"expiration_date\": \"01/15/2025\"\n },\n {\n \"id\": 147,\n \"receipt_number\": \"30000052\",\n \"lot_number\": \"dqw\",\n \"received_quantity\": 2,\n \"received_on\": \"01/15/2025\",\n \"expiration_date\": \"01/15/2025\"\n },\n {\n \"id\": 148,\n \"receipt_number\": \"30000052\",\n \"lot_number\": \"cas\",\n \"received_quantity\": 1,\n \"received_on\": \"01/15/2025\",\n \"expiration_date\": \"01/15/2025\"\n },\n {\n \"id\": 149,\n \"receipt_number\": \"30000052\",\n \"lot_number\": \"test\",\n \"received_quantity\": 1,\n \"received_on\": \"01/15/2025\",\n \"expiration_date\": \"\"\n }\n ]\n}\n\nRoot Fields:
\nResult Object Structure:
\n","urlObject":{"protocol":"https","path":["api","v2","inventories","1552","lot_trackings"],"host":["myprocuredesk","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"7d65ed57-e12d-4728-aa88-b6250dbb5986"},{"name":"Assets Details","id":"971a4461-43ef-46a2-b79e-f57bb6c79d4c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Method:
\nGET
Endpoint:
\n/api/v2/inventories/1552/asset_tags?max_results=2&page=1
Sample Request:
\nhttps://myprocuredesk.com/api/v2/inventories/1552/asset_tags
Sample Response:
\n{\n \"status\": true,\n \"result\": [\n {\n \"id\": 346,\n \"receipt_number\": \"30000052\",\n \"serial_no\": \"cwe\",\n \"quantity\": 1,\n \"receipt_date\": \"01/15/2025\"\n },\n {\n \"id\": 347,\n \"receipt_number\": \"30000052\",\n \"serial_no\": \"dw\",\n \"quantity\": 1,\n \"receipt_date\": \"01/15/2025\"\n },\n {\n \"id\": 348,\n \"receipt_number\": \"30000052\",\n \"serial_no\": \"cwed\",\n \"quantity\": 1,\n \"receipt_date\": \"01/15/2025\"\n },\n {\n \"id\": 349,\n \"receipt_number\": \"30000052\",\n \"serial_no\": \"cw\",\n \"quantity\": 1,\n \"receipt_date\": \"01/15/2025\"\n },\n {\n \"id\": 350,\n \"receipt_number\": \"30000052\",\n \"serial_no\": \"acs\",\n \"quantity\": 1,\n \"receipt_date\": \"01/15/2025\"\n }\n ]\n}\n\nMethod:GET
Endpoint:/api/v2/inventories/{inventory_id}/receipts
Sample Request:
\nhttps://myprocuredesk.com/api/v2/inventories/1552/receipts
Sample Response:
\n{\n \"status\": true,\n \"result\": [\n {\n \"receipt_no\": \"30000013\",\n \"received_date\": \"12/30/2024\",\n \"unit_price\": 10000,\n \"ordered_qty\": 1,\n \"received_qty\": 5,\n \"uom\": \"EACH\",\n \"created_at\": \"12/30/2024\"\n },\n {\n \"receipt_no\": \"30000052\",\n \"received_date\": \"01/15/2025\",\n \"unit_price\": 10000,\n \"ordered_qty\": 10,\n \"received_qty\": 10,\n \"uom\": \"EACH\",\n \"created_at\": \"01/15/2025\"\n },\n {\n \"receipt_no\": \"30000061\",\n \"received_date\": \"02/28/2025\",\n \"unit_price\": 10000,\n \"ordered_qty\": 100,\n \"received_qty\": 50,\n \"uom\": \"EACH\",\n \"created_at\": \"02/28/2025\"\n },\n {\n \"receipt_no\": \"30000062\",\n \"received_date\": \"02/28/2025\",\n \"unit_price\": 10000,\n \"ordered_qty\": 100,\n \"received_qty\": 50,\n \"uom\": \"EACH\",\n \"created_at\": \"02/28/2025\"\n },\n {\n \"receipt_no\": \"30000063\",\n \"received_date\": \"02/28/2025\",\n \"unit_price\": 10000,\n \"ordered_qty\": 100,\n \"received_qty\": 50,\n \"uom\": \"EACH\",\n \"created_at\": \"02/28/2025\"\n },\n {\n \"receipt_no\": \"30000064\",\n \"received_date\": \"02/28/2025\",\n \"unit_price\": 10000,\n \"ordered_qty\": 100,\n \"received_qty\": 50,\n \"uom\": \"EACH\",\n \"created_at\": \"02/28/2025\"\n }\n ]\n}\n\nMethod:GET
Endpoint:/api/v2/inventories/{inventory_id}
Sample Request:
\nhttps://myprocuredesk.com/api/v2/inventories/1552
Sample Response:
\nResponse - \n{ \n \"status\": true, \n \"result\": { \n \"id\": 1552, \n \"item_name\": \"TV\", \n \"on_hand\": \"195.0\", \n \"supplier_name\": \"Test Supplier\", \n \"supplier_item_no\": \"Supplier Item Number\", \n \"manufacturer_name\": \"MFR name\", \n \"manufacturer_no\": \"MFR Part #\", \n \"item_no\": \"1\", \n \"on_hand_locations\": [ \n { \n \"location_id\": 58, \n \"location\": \"J&K\", \n \"quantity\": 0 \n }, \n { \n \"location_id\": 247, \n \"location\": \"Goa\", \n \"quantity\": 10 \n }, \n { \n \"location_id\": 269, \n \"location\": \"Test\", \n \"quantity\": 0 \n }, \n { \n \"location_id\": 59, \n \"location\": \"Hydrabad\", \n \"quantity\": 0 \n }, \n { \n \"location_id\": 44, \n \"location\": \"Mumbai\", \n \"quantity\": 119 \n }, \n { \n \"location_id\": 47, \n \"location\": \"Delhi\", \n \"quantity\": 5 \n }, \n { \n \"location_id\": 268, \n \"location\": \"HQ\", \n \"quantity\": 50 \n }, \n { \n \"location_id\": 45, \n \"location\": \"Jaipur\", \n \"quantity\": 11 \n } \n ], \n \"released_quantity\": 137, \n \"return_quantity\": 136, \n \"remaining_return_qty\": 1, \n \"quickbook_inventory_adjustment\": { \n \"enable_quickbook\": true, \n \"default_account_id\": 2111 \n }, \n \"project_code_flag\": true \n } \n} \n\nThis endpoint makes an HTTP GET request to retrieve a list of inventories from the ProcureDesk API.
\nNo request body is required for this endpoint. The request is sent to the following URL:
\nhttps://myprocuredesk.com/api/v2/inventories/list\n\nThe response will include a list of inventories with details such as inventory ID, name, quantity, and other relevant information.
\n","urlObject":{"protocol":"https","path":["api","v2","inventories","list"],"host":["myprocuredesk","com"],"query":[{"disabled":true,"key":"max_results","value":null},{"disabled":true,"key":"page","value":null}],"variable":[]}},"response":[],"_postman_id":"62f1387f-0772-4eae-bc31-2609324346fa"},{"name":"Create Inventory Location","id":"3352d2a8-fc5b-44d5-a041-a7be2c62cc98","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"inventory_locations\": [\n {\n \"name\": \"Warehouse A\",\n \"details\": \"Main storage facility\",\n \"status\": true\n },\n {\n \"name\": \"Warehouse B\",\n \"details\": \"Secondary storage\",\n \"status\": true\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://myprocuredesk.com/api/v2/inventory_locations","description":"This endpoint allows users to add a new inventory location to the system.
\nPOST
https://myprocuredesk.com/api/v2/inventory_locations
The request must include a JSON object containing the inventory_locations key, which is an array of objects. Each object in the array must have the following parameters:
name (string): The name of the inventory location.
details (string): A description of the inventory location. This field provides additional context.
status (boolean): Indicates whether the inventory location is active or inactive.
{\n \"inventory_locations\": [\n {\n \"name\": \"Warehouse A\",\n \"details\": \"Main storage facility\",\n \"status\": true\n }\n ]\n}\n\nUpon successfully adding the inventory location, the API will return a response in JSON format, typically containing the details of the created inventory location, including its unique identifier and the values provided in the request.
\nThe response will include:
\nA confirmation of the successful addition of the inventory location.
\nThe details of the created inventory location, including the id, name, details, status, created_at, and updated_at.
This endpoint is essential for managing inventory locations within the application, ensuring users can effectively organize their inventory.
\n","urlObject":{"protocol":"https","path":["api","v2","inventory_locations"],"host":["myprocuredesk","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"3352d2a8-fc5b-44d5-a041-a7be2c62cc98"},{"name":"Update Inventory Location","id":"9978afdb-174e-4389-9bb0-4e806fed8890","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"inventory_locations\": [\n {\n \"id\": 73,\n \"name\": \"Warehouse Test Plate\",\n \"details\": \"Main storage facility Important\",\n \"status\": true\n },\n {\n \"id\": 74,\n \"name\": \"Warehouse Best\",\n \"details\": \"Secondary storage - Not Include\",\n \"status\": true\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://myprocuredesk.com/api/v2/inventory_locations","description":"This endpoint allows you to update an existing inventory location in the system by sending a PUT request to the specified URL with the appropriate inventory location ID. This operation is essential for maintaining accurate and up-to-date information regarding inventory locations.
\nThe request body must be in JSON format and should contain the following parameters:
\ninventory_locations: An array of objects representing the inventory locations to be updated.
id (integer): The unique identifier of the inventory location that you wish to update.
name (string): The name of the inventory location.
details (string): A description providing additional information about the location.
status (boolean): The current status of the inventory location, indicating whether it is active or inactive.
{\n \"inventory_locations\": [\n {\n \"id\": 73,\n \"name\": \"Warehouse Test Plate\",\n \"details\": \"Main storage facility Importan ...\",\n \"status\": true\n }\n ]\n}\n\nUpon successful completion of the request, the server will respond with a status code indicating the result of the operation. The response typically includes the updated inventory location details, confirming that the changes have been applied.
\nThe response will generally contain the updated inventory location object with the same structure as the request, ensuring that the client has the latest information.
\nThis endpoint is crucial for maintaining accurate and up-to-date information regarding inventory locations in the system.
\n","urlObject":{"protocol":"https","path":["api","v2","inventory_locations"],"host":["myprocuredesk","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"9978afdb-174e-4389-9bb0-4e806fed8890"}],"id":"f88410de-66aa-4051-9b17-531e56e51185","_postman_id":"f88410de-66aa-4051-9b17-531e56e51185","description":""},{"name":"Request","item":[{"name":"Create","id":"864a4614-0891-4ae4-a795-ddf8e88c069f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"request_purchase\": {\n \"delivery_contact\": \"Test User\",\n \"project_code\": \"Project Code Test\",\n \"name\": \"Description Name\",\n \"contact\": \"Test User\",\n \"business_unit\": \"Sample Business unit\",\n \"department\": \"Administration\",\n \"requisition_type\": \"Quote request\",\n \"payment_method\": \"ACH\",\n \"request_items_attributes\": [\n {\n \"category\": \"Test\",\n \"source_from\": \"vendor\",\n \"quantity\": 2,\n \"unit_price\": 100,\n \"notes\": \"ABC\",\n \"match_type\": \"material\",\n \"supplier\": \"Sample Suppliers\",\n \"uom_master\": \"EA\",\n \"description\": \"Test REQ 1\",\n \"supplier_item_no\": 736683,\n \"budget_value_breakup_name\": \"Line 1 / Line 2: Line 3\",\n \"required_date\": \"03/20/2025\",\n \"item_name\": \"Ssample item name\",\n \"item_no\": \"123\"\n }\n ]\n }\n}\n","options":{"raw":{"language":"json"}}},"url":"https://myprocuredesk.com/api/v2/requests","urlObject":{"protocol":"https","path":["api","v2","requests"],"host":["myprocuredesk","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"864a4614-0891-4ae4-a795-ddf8e88c069f"},{"name":"Update","id":"a7274cf9-96a8-462b-9037-92254066bdd2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"