{ "info": { "name": "ProcurementExpress API", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": "Generated from https://docs.procurementexpress.com. Set access_token (V3) or authentication_token (V1) and company_id." }, "variable": [ { "key": "base_url", "value": "https://app.procurementexpress.com" }, { "key": "access_token", "value": "" }, { "key": "authentication_token", "value": "" }, { "key": "company_id", "value": "" } ], "item": [ { "name": "V3 (OAuth2)", "item": [ { "name": "Authentication", "item": [ { "name": "Get an access token", "request": { "method": "POST", "header": [ ], "url": { "raw": "{{base_url}}/oauth/token", "host": [ "{{base_url}}" ], "path": [ "oauth", "token" ], "query": [ ] }, "body": { "mode": "urlencoded", "urlencoded": [ { "key": "grant_type", "value": "client_credentials" }, { "key": "client_id", "value": "" }, { "key": "client_secret", "value": "" } ] } }, "response": [ ] }, { "name": "Check an access token", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/oauth/token/info", "host": [ "{{base_url}}" ], "path": [ "oauth", "token", "info" ], "query": [ ] } }, "response": [ ] }, { "name": "Introspect an access token", "request": { "method": "POST", "header": [ ], "url": { "raw": "{{base_url}}/oauth/introspect", "host": [ "{{base_url}}" ], "path": [ "oauth", "introspect" ], "query": [ ] }, "body": { "mode": "urlencoded", "urlencoded": [ { "key": "token", "value": "" }, { "key": "client_id", "value": "" }, { "key": "client_secret", "value": "" } ] } }, "response": [ ] }, { "name": "Revoke an access token", "request": { "method": "POST", "header": [ ], "url": { "raw": "{{base_url}}/oauth/revoke", "host": [ "{{base_url}}" ], "path": [ "oauth", "revoke" ], "query": [ ] }, "body": { "mode": "urlencoded", "urlencoded": [ { "key": "token", "value": "" }, { "key": "client_id", "value": "" }, { "key": "client_secret", "value": "" } ] } }, "response": [ ] }, { "name": "Verify a one-time code", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v3/verify_otp", "host": [ "{{base_url}}" ], "path": [ "api", "v3", "verify_otp" ], "query": [ ] }, "body": { "mode": "raw", "raw": "{\n \"email\": \"olivia.otp@example.com\",\n \"otp_attempt\": \"628354\",\n \"slim_companies\": \"1\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ ] }, { "name": "Resend the one-time code", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v3/resend_otp", "host": [ "{{base_url}}" ], "path": [ "api", "v3", "resend_otp" ], "query": [ ] }, "body": { "mode": "raw", "raw": "{\n \"email\": \"olivia.otp@example.com\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ ] }, { "name": "Request a password reset e-mail", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v3/reset_password", "host": [ "{{base_url}}" ], "path": [ "api", "v3", "reset_password" ], "query": [ ] }, "body": { "mode": "raw", "raw": "{\n \"email\": \"lee.login@example.com\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ ] } ] }, { "name": "Approval Flows", "item": [ { "name": "List approval flows", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" } ], "url": { "raw": "{{base_url}}/api/v3/approval_flows?per_page=10", "host": [ "{{base_url}}" ], "path": [ "api", "v3", "approval_flows" ], "query": [ { "key": "per_page", "value": "10" } ] } }, "response": [ ] }, { "name": "Get an approval flow", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" } ], "url": { "raw": "{{base_url}}/api/v3/approval_flows/1", "host": [ "{{base_url}}" ], "path": [ "api", "v3", "approval_flows", "1" ], "query": [ ] } }, "response": [ ] }, { "name": "Create an approval flow", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v3/approval_flows", "host": [ "{{base_url}}" ], "path": [ "api", "v3", "approval_flows" ], "query": [ ] }, "body": { "mode": "raw", "raw": "{\n \"approval_flow\": {\n \"name\": \"Lab PO routing v3\",\n \"document_type\": \"purchase_order\",\n \"self_approval_allowed\": false,\n \"approval_conditions_attributes\": [\n {\n \"property\": \"department\",\n \"operator\": \"equals\",\n \"value\": \"5\"\n }\n ],\n \"approval_steps_attributes\": [\n {\n \"step_no\": 1,\n \"all_should_approve\": false,\n \"approval_step_approvers_attributes\": [\n {\n \"user_id\": 50000\n }\n ]\n },\n {\n \"step_no\": 2,\n \"all_should_approve\": true,\n \"approval_step_approvers_attributes\": [\n {\n \"user_id\": 40000\n },\n {\n \"user_id\": 50000\n }\n ],\n \"approval_conditions_attributes\": [\n {\n \"property\": \"gross_amount\",\n \"operator\": \"greater_than\",\n \"value\": \"1000\"\n }\n ]\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ ] }, { "name": "Update an approval flow", "request": { "method": "PATCH", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v3/approval_flows/2", "host": [ "{{base_url}}" ], "path": [ "api", "v3", "approval_flows", "2" ], "query": [ ] }, "body": { "mode": "raw", "raw": "{\n \"approval_flow\": {\n \"name\": \"Lab PO routing v3 - updated\",\n \"approval_steps_attributes\": [\n {\n \"id\": 4,\n \"approval_step_approvers_attributes\": [\n {\n \"id\": 6,\n \"_destroy\": true\n }\n ],\n \"approval_conditions_attributes\": [\n {\n \"id\": 3,\n \"value\": \"2500\"\n }\n ]\n },\n {\n \"step_no\": 3,\n \"all_should_approve\": false,\n \"approval_step_approvers_attributes\": [\n {\n \"user_id\": 50000\n }\n ],\n \"approval_conditions_attributes\": [\n {\n \"property\": \"gross_amount\",\n \"operator\": \"greater_than\",\n \"value\": \"10000\"\n }\n ]\n }\n ],\n \"approval_conditions_attributes\": [\n {\n \"property\": \"supplier\",\n \"operator\": \"is_any_of\",\n \"value\": \"1,2,3\"\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ ] }, { "name": "Delete an approval flow", "request": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" } ], "url": { "raw": "{{base_url}}/api/v3/approval_flows/6", "host": [ "{{base_url}}" ], "path": [ "api", "v3", "approval_flows", "6" ], "query": [ ] } }, "response": [ ] }, { "name": "Archive an approval flow", "request": { "method": "PUT", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" } ], "url": { "raw": "{{base_url}}/api/v3/approval_flows/8/archive", "host": [ "{{base_url}}" ], "path": [ "api", "v3", "approval_flows", "8", "archive" ], "query": [ ] } }, "response": [ ] }, { "name": "List the runs of an approval flow", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" } ], "url": { "raw": "{{base_url}}/api/v3/approval_flows/1/runs", "host": [ "{{base_url}}" ], "path": [ "api", "v3", "approval_flows", "1", "runs" ], "query": [ ] } }, "response": [ ] }, { "name": "Get one run of an approval flow", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" } ], "url": { "raw": "{{base_url}}/api/v3/approval_flows/1/show_entity?entity_id=1", "host": [ "{{base_url}}" ], "path": [ "api", "v3", "approval_flows", "1", "show_entity" ], "query": [ { "key": "entity_id", "value": "1" } ] } }, "response": [ ] }, { "name": "List the versions of an approval flow", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" } ], "url": { "raw": "{{base_url}}/api/v3/approval_flows/1/versions", "host": [ "{{base_url}}" ], "path": [ "api", "v3", "approval_flows", "1", "versions" ], "query": [ ] } }, "response": [ ] }, { "name": "Get a version of an approval flow", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" } ], "url": { "raw": "{{base_url}}/api/v3/approval_flows/1/version_details?version_id=55", "host": [ "{{base_url}}" ], "path": [ "api", "v3", "approval_flows", "1", "version_details" ], "query": [ { "key": "version_id", "value": "55" } ] } }, "response": [ ] }, { "name": "Rerun approval flows for documents", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v3/approval_flows/rerun_approval_flows", "host": [ "{{base_url}}" ], "path": [ "api", "v3", "approval_flows", "rerun_approval_flows" ], "query": [ ] }, "body": { "mode": "raw", "raw": "{\n \"order_ids\": [\n 47\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ ] } ] }, { "name": "Budgets", "item": [ { "name": "List budgets", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" } ], "url": { "raw": "{{base_url}}/api/v3/budgets?department_id=3", "host": [ "{{base_url}}" ], "path": [ "api", "v3", "budgets" ], "query": [ { "key": "department_id", "value": "3" } ] } }, "response": [ ] }, { "name": "Get a budget", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" } ], "url": { "raw": "{{base_url}}/api/v3/budgets/1", "host": [ "{{base_url}}" ], "path": [ "api", "v3", "budgets", "1" ], "query": [ ] } }, "response": [ ] }, { "name": "Create a budget", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v3/budgets", "host": [ "{{base_url}}" ], "path": [ "api", "v3", "budgets" ], "query": [ ] }, "body": { "mode": "raw", "raw": "{\n \"budget\": {\n \"name\": \"Field Marketing FY27\",\n \"amount\": 8000,\n \"cost_code\": \"FMK-27\",\n \"cost_type\": \"Opex\",\n \"start_date\": \"10/01/2026\",\n \"end_date\": \"09/30/2027\",\n \"department_ids\": [\n 3\n ],\n \"approver_ids\": [\n 40000,\n 50000\n ],\n \"chart_of_account_id\": 3,\n \"allow_anyone_to_approve_a_po\": false\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ ] }, { "name": "Update a budget", "request": { "method": "PUT", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v3/budgets/6", "host": [ "{{base_url}}" ], "path": [ "api", "v3", "budgets", "6" ], "query": [ ] }, "body": { "mode": "raw", "raw": "{\n \"budget\": {\n \"amount\": 9500,\n \"end_date\": \"12/31/2027\",\n \"approver_ids\": [\n 40000\n ],\n \"department_ids\": [\n 3,\n 2\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ ] }, { "name": "Archive a budget", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" } ], "url": { "raw": "{{base_url}}/api/v3/budgets/11/archive", "host": [ "{{base_url}}" ], "path": [ "api", "v3", "budgets", "11", "archive" ], "query": [ ] } }, "response": [ ] }, { "name": "Unarchive a budget", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" } ], "url": { "raw": "{{base_url}}/api/v3/budgets/11/unarchive", "host": [ "{{base_url}}" ], "path": [ "api", "v3", "budgets", "11", "unarchive" ], "query": [ ] } }, "response": [ ] } ] }, { "name": "Companies", "item": [ { "name": "List companies", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" } ], "url": { "raw": "{{base_url}}/api/v3/companies", "host": [ "{{base_url}}" ], "path": [ "api", "v3", "companies" ], "query": [ ] } }, "response": [ ] }, { "name": "Get the current company", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" } ], "url": { "raw": "{{base_url}}/api/v3/companies/details", "host": [ "{{base_url}}" ], "path": [ "api", "v3", "companies", "details" ], "query": [ ] } }, "response": [ ] }, { "name": "Get a company", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" } ], "url": { "raw": "{{base_url}}/api/v3/companies/20000", "host": [ "{{base_url}}" ], "path": [ "api", "v3", "companies", "20000" ], "query": [ ] } }, "response": [ ] }, { "name": "Create a company", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v3/companies", "host": [ "{{base_url}}" ], "path": [ "api", "v3", "companies" ], "query": [ ] }, "body": { "mode": "raw", "raw": "{\n \"company\": {\n \"name\": \"Globex Subsidiary\",\n \"department\": \"Finance\",\n \"gross_or_net_config\": \"net\",\n \"default_tax_rate\": 0,\n \"company_setting_attributes\": {\n \"currency_id\": 2000,\n \"date_format\": \"%Y-%m-%d\",\n \"tax_label\": \"VAT\"\n },\n \"supported_currency_ids\": [\n 2000,\n 1000\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ ] }, { "name": "List approvers", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" } ], "url": { "raw": "{{base_url}}/api/v3/companies/approvers", "host": [ "{{base_url}}" ], "path": [ "api", "v3", "companies", "approvers" ], "query": [ ] } }, "response": [ ] }, { "name": "List all approvers", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" } ], "url": { "raw": "{{base_url}}/api/v3/companies/all_approvers", "host": [ "{{base_url}}" ], "path": [ "api", "v3", "companies", "all_approvers" ], "query": [ ] } }, "response": [ ] }, { "name": "List employees", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" } ], "url": { "raw": "{{base_url}}/api/v3/companies/employees", "host": [ "{{base_url}}" ], "path": [ "api", "v3", "companies", "employees" ], "query": [ ] } }, "response": [ ] }, { "name": "Get the invite limit", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" } ], "url": { "raw": "{{base_url}}/api/v3/companies/invite_limit_left", "host": [ "{{base_url}}" ], "path": [ "api", "v3", "companies", "invite_limit_left" ], "query": [ ] } }, "response": [ ] }, { "name": "List the company's chart of accounts", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" } ], "url": { "raw": "{{base_url}}/api/v3/companies/chart_of_accounts", "host": [ "{{base_url}}" ], "path": [ "api", "v3", "companies", "chart_of_accounts" ], "query": [ ] } }, "response": [ ] }, { "name": "Invite a user", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v3/companies/send_user_invite", "host": [ "{{base_url}}" ], "path": [ "api", "v3", "companies", "send_user_invite" ], "query": [ ] }, "body": { "mode": "raw", "raw": "{\n \"invite_user\": {\n \"email\": \"new.hire+v3@example.com\",\n \"name\": \"Nora Hire\",\n \"roles\": [\n \"approver\",\n \"teammember\"\n ],\n \"approval_limit\": 2500,\n \"department_ids\": [\n 2,\n 3\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ ] } ] }, { "name": "Currencies", "item": [ { "name": "List the company's currencies", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" } ], "url": { "raw": "{{base_url}}/api/v3/currencies", "host": [ "{{base_url}}" ], "path": [ "api", "v3", "currencies" ], "query": [ ] } }, "response": [ ] }, { "name": "List all currencies", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" } ], "url": { "raw": "{{base_url}}/api/v3/all_currencies", "host": [ "{{base_url}}" ], "path": [ "api", "v3", "all_currencies" ], "query": [ ] } }, "response": [ ] } ] }, { "name": "Custom Fields", "item": [ { "name": "Set a custom field value", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v3/custom_field_values", "host": [ "{{base_url}}" ], "path": [ "api", "v3", "custom_field_values" ], "query": [ ] }, "body": { "mode": "raw", "raw": "{\n \"custom_field_value\": {\n \"id\": 47,\n \"custom_field_id\": 2,\n \"purchase_order_id\": 12,\n \"value\": \"CC-300 Operations\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ ] } ] }, { "name": "Departments", "item": [ { "name": "List departments", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" } ], "url": { "raw": "{{base_url}}/api/v3/departments", "host": [ "{{base_url}}" ], "path": [ "api", "v3", "departments" ], "query": [ ] } }, "response": [ ] }, { "name": "Get a department", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" } ], "url": { "raw": "{{base_url}}/api/v3/departments/2", "host": [ "{{base_url}}" ], "path": [ "api", "v3", "departments", "2" ], "query": [ ] } }, "response": [ ] }, { "name": "Create a department", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v3/departments", "host": [ "{{base_url}}" ], "path": [ "api", "v3", "departments" ], "query": [ ] }, "body": { "mode": "raw", "raw": "{\n \"department\": {\n \"name\": \"Procurement\",\n \"contact_person\": \"Jane Doe\",\n \"phone_number\": \"+1 555 0130\",\n \"email\": \"procurement@example.com\",\n \"address\": \"300 Supply Road, Springfield, IL 62701\",\n \"tax_number\": \"US-PR-003\",\n \"budget_ids\": [\n 3\n ],\n \"user_ids\": [\n 40000\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ ] }, { "name": "Update a department", "request": { "method": "PUT", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v3/departments/17", "host": [ "{{base_url}}" ], "path": [ "api", "v3", "departments", "17" ], "query": [ ] }, "body": { "mode": "raw", "raw": "{\n \"department\": {\n \"name\": \"Procurement & Sourcing\",\n \"contact_person\": \"Marco Rossi\",\n \"phone_number\": \"+1 555 0131\",\n \"budget_ids\": [\n\n ],\n \"user_ids\": [\n 40000\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ ] } ] }, { "name": "Invoices", "item": [ { "name": "List invoices", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" } ], "url": { "raw": "{{base_url}}/api/v3/invoices?invoice_statuses_filter=settled&supplier_id%5B%5D=2&sort=invoices.invoice_number&direction=asc", "host": [ "{{base_url}}" ], "path": [ "api", "v3", "invoices" ], "query": [ { "key": "invoice_statuses_filter", "value": "settled" }, { "key": "supplier_id[]", "value": "2" }, { "key": "sort", "value": "invoices.invoice_number" }, { "key": "direction", "value": "asc" } ] } }, "response": [ ] }, { "name": "Get an invoice", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" } ], "url": { "raw": "{{base_url}}/api/v3/invoices/1", "host": [ "{{base_url}}" ], "path": [ "api", "v3", "invoices", "1" ], "query": [ ] } }, "response": [ ] }, { "name": "Create an invoice", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v3/invoices", "host": [ "{{base_url}}" ], "path": [ "api", "v3", "invoices" ], "query": [ ] }, "body": { "mode": "raw", "raw": "{\n \"invoice\": {\n \"invoice_number\": \"CH-2026-1002\",\n \"supplier_id\": 2,\n \"currency_id\": 2000,\n \"issue_date\": \"2026-10-20\",\n \"received_date\": \"2026-10-21\",\n \"due_date\": \"2026-11-19\",\n \"gross_amount\": \"990.00\",\n \"invoice_line_items_attributes\": [\n {\n \"sequence_no\": 1,\n \"description\": \"USB-C dock\",\n \"quantity\": 2,\n \"unit_price\": 150,\n \"vat\": 10,\n \"net_amount\": 300,\n \"tax_rate_id\": 4,\n \"purchase_order_id\": 4,\n \"purchase_order_item_id\": 6\n },\n {\n \"sequence_no\": 2,\n \"description\": \"27in monitor\",\n \"quantity\": 2,\n \"unit_price\": 300,\n \"vat\": 10,\n \"net_amount\": 600,\n \"tax_rate_id\": 4,\n \"purchase_order_id\": 4,\n \"purchase_order_item_id\": 7\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ ] }, { "name": "Update an invoice", "request": { "method": "PUT", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v3/invoices/2", "host": [ "{{base_url}}" ], "path": [ "api", "v3", "invoices", "2" ], "query": [ ] }, "body": { "mode": "raw", "raw": "{\n \"invoice\": {\n \"due_date\": \"2026-12-04\",\n \"payment_term_id\": 3,\n \"custom_field_values_attributes\": [\n {\n \"custom_field_id\": 4,\n \"value\": \"AP-2026-10-B\"\n }\n ],\n \"invoice_line_items_attributes\": [\n {\n \"id\": 3,\n \"quantity\": 3,\n \"net_amount\": 450\n },\n {\n \"id\": 4,\n \"_destroy\": true\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ ] }, { "name": "List purchase orders to invoice", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" } ], "url": { "raw": "{{base_url}}/api/v3/invoices/purchase_order_list?supplier_id=2&per_page=2&selected_ids=10", "host": [ "{{base_url}}" ], "path": [ "api", "v3", "invoices", "purchase_order_list" ], "query": [ { "key": "supplier_id", "value": "2" }, { "key": "per_page", "value": "2" }, { "key": "selected_ids", "value": "10" } ] } }, "response": [ ] }, { "name": "List purchase order lines to invoice", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" } ], "url": { "raw": "{{base_url}}/api/v3/invoices/purchase_order_item_list?purchase_order_ids%5B%5D=1&purchase_order_ids%5B%5D=5", "host": [ "{{base_url}}" ], "path": [ "api", "v3", "invoices", "purchase_order_item_list" ], "query": [ { "key": "purchase_order_ids[]", "value": "1" }, { "key": "purchase_order_ids[]", "value": "5" } ] } }, "response": [ ] }, { "name": "Comment on an invoice", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v3/invoices/2/create_comment", "host": [ "{{base_url}}" ], "path": [ "api", "v3", "invoices", "2", "create_comment" ], "query": [ ] }, "body": { "mode": "raw", "raw": "{\n \"invoice_comments\": {\n \"comment\": \"Quantity corrected to 3 docks per the delivery note. See https://example.com/dn/4471\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ ] }, { "name": "Accept an invoice awaiting review", "request": { "method": "PUT", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" } ], "url": { "raw": "{{base_url}}/api/v3/invoices/15/accept", "host": [ "{{base_url}}" ], "path": [ "api", "v3", "invoices", "15", "accept" ], "query": [ ] } }, "response": [ ] }, { "name": "Approve an invoice", "request": { "method": "PUT", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" } ], "url": { "raw": "{{base_url}}/api/v3/invoices/7/approve", "host": [ "{{base_url}}" ], "path": [ "api", "v3", "invoices", "7", "approve" ], "query": [ ] } }, "response": [ ] }, { "name": "Reject an invoice", "request": { "method": "PUT", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" } ], "url": { "raw": "{{base_url}}/api/v3/invoices/9/reject", "host": [ "{{base_url}}" ], "path": [ "api", "v3", "invoices", "9", "reject" ], "query": [ ] } }, "response": [ ] }, { "name": "Cancel an invoice", "request": { "method": "PUT", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" } ], "url": { "raw": "{{base_url}}/api/v3/invoices/11/cancel", "host": [ "{{base_url}}" ], "path": [ "api", "v3", "invoices", "11", "cancel" ], "query": [ ] } }, "response": [ ] }, { "name": "Archive an invoice", "request": { "method": "PUT", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" } ], "url": { "raw": "{{base_url}}/api/v3/invoices/13/archive", "host": [ "{{base_url}}" ], "path": [ "api", "v3", "invoices", "13", "archive" ], "query": [ ] } }, "response": [ ] }, { "name": "Unarchive an invoice", "request": { "method": "PUT", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" } ], "url": { "raw": "{{base_url}}/api/v3/invoices/13/dearchive", "host": [ "{{base_url}}" ], "path": [ "api", "v3", "invoices", "13", "dearchive" ], "query": [ ] } }, "response": [ ] }, { "name": "Scan an invoice document", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" } ], "url": { "raw": "{{base_url}}/api/v3/digital_invoices", "host": [ "{{base_url}}" ], "path": [ "api", "v3", "digital_invoices" ], "query": [ ] }, "body": { "mode": "formdata", "formdata": [ { "key": "upload_type", "value": "invoice", "type": "text" }, { "key": "file", "type": "file", "src": "invoice-CH-2026-1003.pdf" } ] } }, "response": [ ] } ] }, { "name": "Payments", "item": [ { "name": "Get a payment", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" } ], "url": { "raw": "{{base_url}}/api/v3/npayments/2", "host": [ "{{base_url}}" ], "path": [ "api", "v3", "npayments", "2" ], "query": [ ] } }, "response": [ ] }, { "name": "Record a payment", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v3/npayments", "host": [ "{{base_url}}" ], "path": [ "api", "v3", "npayments" ], "query": [ ] }, "body": { "mode": "raw", "raw": "{\n \"npayment\": {\n \"reference\": \"ACH-20261021-02\",\n \"ptype\": \"bank_transfer\",\n \"payment_mode\": \"normal\",\n \"date\": \"2026-10-21\",\n \"amount\": 165.0,\n \"npayment_invoices_attributes\": [\n {\n \"invoice_id\": 17,\n \"gross_amount\": 165.0\n }\n ],\n \"npayment_comments_attributes\": [\n {\n \"comment\": \"Paid by ACH from operating account\"\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ ] }, { "name": "Mark a purchase order as paid", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v3/purchase_orders/7/payments", "host": [ "{{base_url}}" ], "path": [ "api", "v3", "purchase_orders", "7", "payments" ], "query": [ ] }, "body": { "mode": "raw", "raw": "{\n \"payment\": {\n \"amount\": 1306.5,\n \"note\": \"Paid in full by wire, ref WIRE-88214\",\n \"purchase_order_item_payments_attributes\": [\n {\n \"purchase_order_item_id\": 12,\n \"amount\": 653.25\n },\n {\n \"purchase_order_item_id\": 13,\n \"amount\": 653.25\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ ] } ] }, { "name": "Products", "item": [ { "name": "List products", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" } ], "url": { "raw": "{{base_url}}/api/v3/products?supplier_id=5", "host": [ "{{base_url}}" ], "path": [ "api", "v3", "products" ], "query": [ { "key": "supplier_id", "value": "5" } ] } }, "response": [ ] }, { "name": "Get a product", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" } ], "url": { "raw": "{{base_url}}/api/v3/products/9", "host": [ "{{base_url}}" ], "path": [ "api", "v3", "products", "9" ], "query": [ ] } }, "response": [ ] }, { "name": "List product SKUs", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" } ], "url": { "raw": "{{base_url}}/api/v3/products/skus", "host": [ "{{base_url}}" ], "path": [ "api", "v3", "products", "skus" ], "query": [ ] } }, "response": [ ] }, { "name": "Create a product", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v3/products", "host": [ "{{base_url}}" ], "path": [ "api", "v3", "products" ], "query": [ ] }, "body": { "mode": "raw", "raw": "{\n \"product\": {\n \"sku\": \"CABLE-USBC-2M\",\n \"description\": \"USB-C cable, 2 m\",\n \"unit_price\": 12.99,\n \"supplier_id\": 5,\n \"budget_id\": 1,\n \"tax_rate_id\": 4\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ ] }, { "name": "Bulk-create products for a supplier", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v3/products/bulk_create", "host": [ "{{base_url}}" ], "path": [ "api", "v3", "products", "bulk_create" ], "query": [ ] }, "body": { "mode": "raw", "raw": "{\n \"supplier_id\": 5,\n \"product\": {\n \"product_item_attributes\": [\n {\n \"sku\": \"HDMI-2M\",\n \"description\": \"HDMI 2.1 cable, 2 m\",\n \"unit_price\": 9.99\n },\n {\n \"sku\": \"KB-WL-01\",\n \"description\": \"Wireless keyboard\",\n \"unit_price\": 49.0\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ ] }, { "name": "Update a product", "request": { "method": "PUT", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v3/products/10", "host": [ "{{base_url}}" ], "path": [ "api", "v3", "products", "10" ], "query": [ ] }, "body": { "mode": "raw", "raw": "{\n \"product\": {\n \"description\": \"USB-C cable, 2 m, braided\",\n \"unit_price\": 14.5,\n \"budget_id\": 3\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ ] } ] }, { "name": "Purchase Orders", "item": [ { "name": "List purchase orders", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" } ], "url": { "raw": "{{base_url}}/api/v3/purchase_orders?budget_id=10", "host": [ "{{base_url}}" ], "path": [ "api", "v3", "purchase_orders" ], "query": [ { "key": "budget_id", "value": "10" } ] } }, "response": [ ] }, { "name": "Get a purchase order", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" } ], "url": { "raw": "{{base_url}}/api/v3/purchase_orders/19", "host": [ "{{base_url}}" ], "path": [ "api", "v3", "purchase_orders", "19" ], "query": [ ] } }, "response": [ ] }, { "name": "New purchase order template", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" } ], "url": { "raw": "{{base_url}}/api/v3/purchase_orders/new", "host": [ "{{base_url}}" ], "path": [ "api", "v3", "purchase_orders", "new" ], "query": [ ] } }, "response": [ ] }, { "name": "Create a purchase order", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v3/purchase_orders", "host": [ "{{base_url}}" ], "path": [ "api", "v3", "purchase_orders" ], "query": [ ] }, "body": { "mode": "raw", "raw": "{\n \"commit\": \"Send\",\n \"purchase_order\": {\n \"supplier_id\": 2,\n \"department_id\": 2,\n \"currency_id\": 2000,\n \"notes\": \"Monitors and docks for the Q4 engineering hires\",\n \"purchase_order_items_attributes\": [\n {\n \"product_id\": 2,\n \"item_number\": \"MON-27\",\n \"description\": \"27-inch 4K monitor\",\n \"quantity\": 4,\n \"unit_price\": 329.99,\n \"budget_id\": 1,\n \"tax_rate_id\": 4,\n \"vat\": 8.875,\n \"custom_field_values_attributes\": [\n {\n \"custom_field_id\": 3,\n \"value\": \"AT-0441\"\n }\n ]\n },\n {\n \"product_id\": 3,\n \"item_number\": \"DOCK-USB-C\",\n \"description\": \"USB-C docking station\",\n \"quantity\": 4,\n \"unit_price\": 189.5,\n \"budget_id\": 1,\n \"tax_rate_id\": 4,\n \"vat\": 8.875\n }\n ],\n \"custom_field_values_attributes\": [\n {\n \"custom_field_id\": 1,\n \"value\": \"PRJ-2026-014\"\n },\n {\n \"custom_field_id\": 2,\n \"value\": \"CC-100 Engineering\"\n }\n ],\n \"approver_list\": [\n 50000\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ ] }, { "name": "Update a purchase order", "request": { "method": "PUT", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v3/purchase_orders/54", "host": [ "{{base_url}}" ], "path": [ "api", "v3", "purchase_orders", "54" ], "query": [ ] }, "body": { "mode": "raw", "raw": "{\n \"commit\": \"Send\",\n \"purchase_order\": {\n \"notes\": \"Docking stations and a monitor for the design team, submitted for approval\",\n \"approver_list\": [\n 50000\n ],\n \"purchase_order_items_attributes\": [\n {\n \"id\": 77,\n \"quantity\": 3,\n \"custom_field_values_attributes\": [\n {\n \"id\": 188,\n \"custom_field_id\": 3,\n \"value\": \"AT-0502\"\n }\n ]\n },\n {\n \"product_id\": 2,\n \"item_number\": \"MON-27\",\n \"description\": \"27-inch 4K monitor\",\n \"quantity\": 1,\n \"unit_price\": 329.99,\n \"budget_id\": 1,\n \"tax_rate_id\": 4,\n \"vat\": 8.875\n }\n ],\n \"custom_field_values_attributes\": [\n {\n \"id\": 186,\n \"custom_field_id\": 1,\n \"value\": \"PRJ-2026-031\"\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ ] }, { "name": "Create purchase orders in bulk", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v3/purchase_orders/bulk_save", "host": [ "{{base_url}}" ], "path": [ "api", "v3", "purchase_orders", "bulk_save" ], "query": [ ] }, "body": { "mode": "raw", "raw": "{\n \"purchase_order\": {\n \"data\": [\n {\n \"_id\": \"erp-req-1001\",\n \"commit\": \"Send\",\n \"supplier_id\": 2,\n \"department_id\": 2,\n \"currency_id\": 2000,\n \"notes\": \"Docking stations for the support desk\",\n \"approver_list\": [\n 50000\n ],\n \"purchase_order_items_attributes\": [\n {\n \"product_id\": 3,\n \"item_number\": \"DOCK-USB-C\",\n \"description\": \"USB-C docking station\",\n \"quantity\": 2,\n \"unit_price\": 189.5,\n \"budget_id\": 1,\n \"tax_rate_id\": 4\n }\n ],\n \"custom_field_values_attributes\": [\n {\n \"custom_field_id\": 1,\n \"value\": \"PRJ-2026-051\"\n }\n ]\n },\n {\n \"_id\": \"erp-req-1002\",\n \"commit\": \"Draft\",\n \"supplier_id\": 1,\n \"department_id\": 3,\n \"currency_id\": 2000,\n \"notes\": \"Whiteboard markers, waiting on a quote\",\n \"purchase_order_items_attributes\": [\n {\n \"description\": \"Whiteboard markers, pack of 12\",\n \"quantity\": 4,\n \"unit_price\": 14.25,\n \"budget_id\": 2,\n \"tax_rate_id\": 4\n }\n ]\n },\n {\n \"_id\": \"erp-req-1003\",\n \"commit\": \"Send\",\n \"supplier_id\": 1,\n \"department_id\": 3,\n \"currency_id\": 2000,\n \"notes\": \"Row with no line items\",\n \"approver_list\": [\n 50000\n ]\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ ] }, { "name": "Approve a purchase order", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v3/purchase_orders/33/approve", "host": [ "{{base_url}}" ], "path": [ "api", "v3", "purchase_orders", "33", "approve" ], "query": [ ] }, "body": { "mode": "raw", "raw": "{\n \"token\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ ] }, { "name": "Reject a purchase order", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v3/purchase_orders/36/reject", "host": [ "{{base_url}}" ], "path": [ "api", "v3", "purchase_orders", "36", "reject" ], "query": [ ] }, "body": { "mode": "raw", "raw": "{\n \"token\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ ] }, { "name": "Override and approve a purchase order", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" } ], "url": { "raw": "{{base_url}}/api/v3/purchase_orders/38/override_and_approve", "host": [ "{{base_url}}" ], "path": [ "api", "v3", "purchase_orders", "38", "override_and_approve" ], "query": [ ] } }, "response": [ ] }, { "name": "Cancel a purchase order", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" } ], "url": { "raw": "{{base_url}}/api/v3/purchase_orders/30/cancel", "host": [ "{{base_url}}" ], "path": [ "api", "v3", "purchase_orders", "30", "cancel" ], "query": [ ] } }, "response": [ ] }, { "name": "Archive a purchase order", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" } ], "url": { "raw": "{{base_url}}/api/v3/purchase_orders/44/archive", "host": [ "{{base_url}}" ], "path": [ "api", "v3", "purchase_orders", "44", "archive" ], "query": [ ] } }, "response": [ ] }, { "name": "Delete a draft purchase order", "request": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" } ], "url": { "raw": "{{base_url}}/api/v3/purchase_orders/46/delete", "host": [ "{{base_url}}" ], "path": [ "api", "v3", "purchase_orders", "46", "delete" ], "query": [ ] } }, "response": [ ] }, { "name": "Count my pending approvals", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" } ], "url": { "raw": "{{base_url}}/api/v3/purchase_orders/pending_request_count", "host": [ "{{base_url}}" ], "path": [ "api", "v3", "purchase_orders", "pending_request_count" ], "query": [ ] } }, "response": [ ] }, { "name": "Preview budget approvers", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" } ], "url": { "raw": "{{base_url}}/api/v3/purchase_orders/auto_approvers_list?budget_ids%5B%5D=1&gross_total=2262.38", "host": [ "{{base_url}}" ], "path": [ "api", "v3", "purchase_orders", "auto_approvers_list" ], "query": [ { "key": "budget_ids[]", "value": "1" }, { "key": "gross_total", "value": "2262.38" } ] } }, "response": [ ] }, { "name": "Preview approval-flow approvers", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v3/purchase_orders/approver_list", "host": [ "{{base_url}}" ], "path": [ "api", "v3", "purchase_orders", "approver_list" ], "query": [ ] }, "body": { "mode": "raw", "raw": "{\n \"test_mode\": true,\n \"approval_flow_id\": 1,\n \"purchase_order\": {\n \"supplier_id\": 2,\n \"department_id\": 5,\n \"currency_id\": 2000,\n \"purchase_order_items_attributes\": [\n {\n \"product_id\": 3,\n \"description\": \"USB-C docking station\",\n \"quantity\": 2,\n \"unit_price\": 189.5,\n \"budget_id\": 4,\n \"tax_rate_id\": 4,\n \"vat\": 8.875\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ ] } ] }, { "name": "Purchase Orders: Attachments", "item": [ { "name": "Upload a file to a purchase order", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" } ], "url": { "raw": "{{base_url}}/api/v3/uploads/po", "host": [ "{{base_url}}" ], "path": [ "api", "v3", "uploads", "po" ], "query": [ ] }, "body": { "mode": "formdata", "formdata": [ { "key": "po_id", "value": "12", "type": "text" }, { "key": "uploads_attributes[upload_token]", "value": "pofulfil-v3-dn-0001", "type": "text" }, { "key": "uploads_attributes[file]", "type": "file", "src": "delivery-note.pdf" } ] } }, "response": [ ] }, { "name": "Upload a file to a PO comment", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" } ], "url": { "raw": "{{base_url}}/api/v3/uploads/poc", "host": [ "{{base_url}}" ], "path": [ "api", "v3", "uploads", "poc" ], "query": [ ] }, "body": { "mode": "formdata", "formdata": [ { "key": "poc_id", "value": "54", "type": "text" }, { "key": "uploads_attributes[upload_token]", "value": "pofulfil-v3-photo-0001", "type": "text" }, { "key": "uploads_attributes[file]", "type": "file", "src": "damaged-box.png" } ] } }, "response": [ ] }, { "name": "Get upload status", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" } ], "url": { "raw": "{{base_url}}/api/v3/uploads/status?upload_token=pofulfil-v3-dn-0001", "host": [ "{{base_url}}" ], "path": [ "api", "v3", "uploads", "status" ], "query": [ { "key": "upload_token", "value": "pofulfil-v3-dn-0001" } ] } }, "response": [ ] } ] }, { "name": "Purchase Orders: Comments", "item": [ { "name": "Comment on a purchase order", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v3/purchase_orders/12/comments", "host": [ "{{base_url}}" ], "path": [ "api", "v3", "purchase_orders", "12", "comments" ], "query": [ ] }, "body": { "mode": "raw", "raw": "{\n \"comment\": \"Paper boxes arrived slightly damaged - marco.rossi@example.com can you hold the invoice until we confirm with Northwind? See https://example.com/claims/1234\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ ] } ] }, { "name": "Purchase Orders: Receiving & Delivery", "item": [ { "name": "Receive items", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v3/purchase_orders/12/receiving_items", "host": [ "{{base_url}}" ], "path": [ "api", "v3", "purchase_orders", "12", "receiving_items" ], "query": [ ] }, "body": { "mode": "raw", "raw": "{\n \"purchase_order\": {\n \"delivered_on\": \"10/20/2026\",\n \"notes\": \"First pallet arrived; markers complete, paper short by 6 boxes\",\n \"items\": [\n {\n \"id\": 22,\n \"quantity\": 4\n },\n {\n \"id\": 23,\n \"quantity\": 6\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ ] }, { "name": "Cancel received items", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" } ], "url": { "raw": "{{base_url}}/api/v3/purchase_orders/14/cancel_receiving_items", "host": [ "{{base_url}}" ], "path": [ "api", "v3", "purchase_orders", "14", "cancel_receiving_items" ], "query": [ ] } }, "response": [ ] }, { "name": "Complete delivery", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" } ], "url": { "raw": "{{base_url}}/api/v3/purchase_orders/16/complete_delivery", "host": [ "{{base_url}}" ], "path": [ "api", "v3", "purchase_orders", "16", "complete_delivery" ], "query": [ ] } }, "response": [ ] } ] }, { "name": "Purchase Orders: Sending to Suppliers", "item": [ { "name": "Send a purchase order to a supplier", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v3/purchase_orders/12/forward", "host": [ "{{base_url}}" ], "path": [ "api", "v3", "purchase_orders", "12", "forward" ], "query": [ ] }, "body": { "mode": "raw", "raw": "{\n \"emails\": \"orders@northwind.example.com\",\n \"cc\": \"accounts.payable@example.com\",\n \"email_subject\": \"Purchase order {PurchaseOrder.Number} from {Company.Name}\",\n \"note\": \"Dear {Supplier.Name},\\n\\nPlease find purchase order {PurchaseOrder.Number} attached, together with our delivery note and a photo of the damaged boxes.\\n\\nThanks,\\n{Requester.Name}\",\n \"uploads\": [\n 5,\n 9\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ ] }, { "name": "Save or update a send-to-supplier template", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v3/purchase_orders/12/forward", "host": [ "{{base_url}}" ], "path": [ "api", "v3", "purchase_orders", "12", "forward" ], "query": [ ] }, "body": { "mode": "raw", "raw": "{\n \"save_template\": true,\n \"template_name\": \"Delivery follow-up\",\n \"email_subject\": \"PO {PurchaseOrder.Number} - delivery schedule\",\n \"note\": \"Dear {Supplier.Name},\\n\\nPlease confirm the delivery date for purchase order {PurchaseOrder.Number}.\\n\\nThanks,\\n{Requester.Name}\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ ] }, { "name": "List send-to-supplier templates", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" } ], "url": { "raw": "{{base_url}}/api/v3/send_to_supplier_templates", "host": [ "{{base_url}}" ], "path": [ "api", "v3", "send_to_supplier_templates" ], "query": [ ] } }, "response": [ ] }, { "name": "Generate a purchase order PDF", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" } ], "url": { "raw": "{{base_url}}/api/v3/purchase_orders/12/generate_pdf", "host": [ "{{base_url}}" ], "path": [ "api", "v3", "purchase_orders", "12", "generate_pdf" ], "query": [ ] } }, "response": [ ] } ] }, { "name": "QuickBooks Online: Chart of Accounts", "item": [ { "name": "List chart of accounts", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" } ], "url": { "raw": "{{base_url}}/api/v3/chart_of_accounts", "host": [ "{{base_url}}" ], "path": [ "api", "v3", "chart_of_accounts" ], "query": [ ] } }, "response": [ ] }, { "name": "Get a chart of account", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" } ], "url": { "raw": "{{base_url}}/api/v3/chart_of_accounts/2", "host": [ "{{base_url}}" ], "path": [ "api", "v3", "chart_of_accounts", "2" ], "query": [ ] } }, "response": [ ] } ] }, { "name": "QuickBooks Online: Classes", "item": [ { "name": "List QuickBooks classes", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" } ], "url": { "raw": "{{base_url}}/api/v3/qbo_classes", "host": [ "{{base_url}}" ], "path": [ "api", "v3", "qbo_classes" ], "query": [ ] } }, "response": [ ] }, { "name": "Get a QuickBooks class", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" } ], "url": { "raw": "{{base_url}}/api/v3/qbo_classes/1", "host": [ "{{base_url}}" ], "path": [ "api", "v3", "qbo_classes", "1" ], "query": [ ] } }, "response": [ ] } ] }, { "name": "QuickBooks Online: Customers", "item": [ { "name": "List QuickBooks customers", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" } ], "url": { "raw": "{{base_url}}/api/v3/qbo_customers", "host": [ "{{base_url}}" ], "path": [ "api", "v3", "qbo_customers" ], "query": [ ] } }, "response": [ ] }, { "name": "Get a QuickBooks customer", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" } ], "url": { "raw": "{{base_url}}/api/v3/qbo_customers/1", "host": [ "{{base_url}}" ], "path": [ "api", "v3", "qbo_customers", "1" ], "query": [ ] } }, "response": [ ] } ] }, { "name": "QuickBooks Online: Item Budget Mappings", "item": [ { "name": "List item budget mappings", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" } ], "url": { "raw": "{{base_url}}/api/v3/qbo_item_budget_mappings", "host": [ "{{base_url}}" ], "path": [ "api", "v3", "qbo_item_budget_mappings" ], "query": [ ] } }, "response": [ ] }, { "name": "Get an item budget mapping", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" } ], "url": { "raw": "{{base_url}}/api/v3/qbo_item_budget_mappings/1", "host": [ "{{base_url}}" ], "path": [ "api", "v3", "qbo_item_budget_mappings", "1" ], "query": [ ] } }, "response": [ ] }, { "name": "Create an item budget mapping", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v3/qbo_item_budget_mappings", "host": [ "{{base_url}}" ], "path": [ "api", "v3", "qbo_item_budget_mappings" ], "query": [ ] }, "body": { "mode": "raw", "raw": "{\n \"qbo_item_budget_mapping\": {\n \"product_id\": 2,\n \"department_id\": 2,\n \"budget_id\": 1\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ ] }, { "name": "Update an item budget mapping", "request": { "method": "PUT", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v3/qbo_item_budget_mappings/3", "host": [ "{{base_url}}" ], "path": [ "api", "v3", "qbo_item_budget_mappings", "3" ], "query": [ ] }, "body": { "mode": "raw", "raw": "{\n \"qbo_item_budget_mapping\": {\n \"budget_id\": 1\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ ] }, { "name": "Delete an item budget mapping", "request": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" } ], "url": { "raw": "{{base_url}}/api/v3/qbo_item_budget_mappings/4", "host": [ "{{base_url}}" ], "path": [ "api", "v3", "qbo_item_budget_mappings", "4" ], "query": [ ] } }, "response": [ ] }, { "name": "Bulk create or update item budget mappings", "request": { "method": "PUT", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v3/qbo_item_budget_mappings/bulk_update", "host": [ "{{base_url}}" ], "path": [ "api", "v3", "qbo_item_budget_mappings", "bulk_update" ], "query": [ ] }, "body": { "mode": "raw", "raw": "{\n \"mappings\": [\n {\n \"product_id\": 1,\n \"department_id\": 4,\n \"budget_id\": 3\n },\n {\n \"product_id\": 3,\n \"department_id\": 2,\n \"budget_id\": 5\n },\n {\n \"product_id\": 2,\n \"department_id\": 2,\n \"budget_id\": 1\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ ] } ] }, { "name": "SAM.gov Supplier Audit", "item": [ { "name": "Check a supplier against SAM.gov", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v3/sam_gov/check", "host": [ "{{base_url}}" ], "path": [ "api", "v3", "sam_gov", "check" ], "query": [ ] }, "body": { "mode": "raw", "raw": "{\n \"supplier_id\": 4,\n \"force\": false\n}", "options": { "raw": { "language": "json" } } } }, "response": [ ] }, { "name": "Get a supplier's latest SAM.gov check", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" } ], "url": { "raw": "{{base_url}}/api/v3/sam_gov/status/4", "host": [ "{{base_url}}" ], "path": [ "api", "v3", "sam_gov", "status", "4" ], "query": [ ] } }, "response": [ ] } ] }, { "name": "Suppliers", "item": [ { "name": "List suppliers", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" } ], "url": { "raw": "{{base_url}}/api/v3/suppliers?search=sup-prod", "host": [ "{{base_url}}" ], "path": [ "api", "v3", "suppliers" ], "query": [ { "key": "search", "value": "sup-prod" } ] } }, "response": [ ] }, { "name": "List the caller's most used suppliers", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" } ], "url": { "raw": "{{base_url}}/api/v3/suppliers/top?top=3", "host": [ "{{base_url}}" ], "path": [ "api", "v3", "suppliers", "top" ], "query": [ { "key": "top", "value": "3" } ] } }, "response": [ ] }, { "name": "Get a supplier", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" } ], "url": { "raw": "{{base_url}}/api/v3/suppliers/4", "host": [ "{{base_url}}" ], "path": [ "api", "v3", "suppliers", "4" ], "query": [ ] } }, "response": [ ] }, { "name": "Create a supplier", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v3/suppliers", "host": [ "{{base_url}}" ], "path": [ "api", "v3", "suppliers" ], "query": [ ] }, "body": { "mode": "raw", "raw": "{\n \"supplier\": {\n \"name\": \"Tailspin Electronics\",\n \"email\": \"sales@tailspin.example.com\",\n \"cc_emails\": \"ar@tailspin.example.com\",\n \"address\": \"88 Circuit Blvd, San Jose, CA 95134\",\n \"contact_person\": \"Mei Chen\",\n \"phone_number\": \"+1 555 0600\",\n \"tax_number\": \"77-4445556\",\n \"currency_id\": 2000,\n \"payment_term_id\": 3,\n \"payment_terms\": \"Net 30\",\n \"notes\": \"Peripherals and cabling\",\n \"external_vendor_id\": \"VEND-1002\",\n \"department_ids\": [\n 2\n ],\n \"uei\": \"TAILS7654321\",\n \"cage_code\": \"9XYZ8\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ ] }, { "name": "Update a supplier", "request": { "method": "PUT", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v3/suppliers/5", "host": [ "{{base_url}}" ], "path": [ "api", "v3", "suppliers", "5" ], "query": [ ] }, "body": { "mode": "raw", "raw": "{\n \"supplier\": {\n \"contact_person\": \"Mei Chen\",\n \"phone_number\": \"+1 555 0601\",\n \"payment_term_id\": 4,\n \"payment_terms\": \"Net 60\",\n \"department_ids\": [\n 2,\n 3\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ ] } ] }, { "name": "Tax Rates", "item": [ { "name": "List tax rates", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" } ], "url": { "raw": "{{base_url}}/api/v3/tax_rates", "host": [ "{{base_url}}" ], "path": [ "api", "v3", "tax_rates" ], "query": [ ] } }, "response": [ ] }, { "name": "Get a tax rate", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" } ], "url": { "raw": "{{base_url}}/api/v3/tax_rates/4", "host": [ "{{base_url}}" ], "path": [ "api", "v3", "tax_rates", "4" ], "query": [ ] } }, "response": [ ] }, { "name": "Create a tax rate", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v3/tax_rates", "host": [ "{{base_url}}" ], "path": [ "api", "v3", "tax_rates" ], "query": [ ] }, "body": { "mode": "raw", "raw": "{\n \"tax_rate\": {\n \"name\": \"City Tax\",\n \"value\": 2.5\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ ] }, { "name": "Update a tax rate", "request": { "method": "PUT", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v3/tax_rates/27", "host": [ "{{base_url}}" ], "path": [ "api", "v3", "tax_rates", "27" ], "query": [ ] }, "body": { "mode": "raw", "raw": "{\n \"tax_rate\": {\n \"name\": \"City Tax 2.75%\",\n \"value\": 2.75\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ ] } ] }, { "name": "Users", "item": [ { "name": "Get the current user", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" } ], "url": { "raw": "{{base_url}}/api/v3/currentuser", "host": [ "{{base_url}}" ], "path": [ "api", "v3", "currentuser" ], "query": [ ] } }, "response": [ ] }, { "name": "Update the current user", "request": { "method": "PUT", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v3/currentuser", "host": [ "{{base_url}}" ], "path": [ "api", "v3", "currentuser" ], "query": [ ] }, "body": { "mode": "raw", "raw": "{\n \"first_name\": \"Lee\",\n \"last_name\": \"Login\",\n \"phone_number\": \"+1 555 0102\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ ] }, { "name": "Update the current user (by id)", "request": { "method": "PATCH", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v3/users/4", "host": [ "{{base_url}}" ], "path": [ "api", "v3", "users", "4" ], "query": [ ] }, "body": { "mode": "raw", "raw": "{\n \"phone_number\": \"+1 555 0104\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ ] } ] }, { "name": "Webhooks", "item": [ { "name": "List webhook subscriptions", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" } ], "url": { "raw": "{{base_url}}/api/v3/webhooks", "host": [ "{{base_url}}" ], "path": [ "api", "v3", "webhooks" ], "query": [ ] } }, "response": [ ] }, { "name": "Retrieve a webhook subscription", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" } ], "url": { "raw": "{{base_url}}/api/v3/webhooks/3", "host": [ "{{base_url}}" ], "path": [ "api", "v3", "webhooks", "3" ], "query": [ ] } }, "response": [ ] }, { "name": "Create a webhook subscription", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v3/webhooks", "host": [ "{{base_url}}" ], "path": [ "api", "v3", "webhooks" ], "query": [ ] }, "body": { "mode": "raw", "raw": "{\n \"webhook\": {\n \"name\": \"ERP purchase order feed (v3, webhooks_internal)\",\n \"url\": \"https://erp.acme.test/pex/webhooks\",\n \"event_type\": [\n \"new_po\",\n \"po_approved\",\n \"po_delivered\",\n \"po_paid\",\n \"po_cancelled\",\n \"po_update\"\n ],\n \"json_wrapper\": \"data\",\n \"send_as_text\": false,\n \"basic_auth_uname\": \"pex-sync\",\n \"basic_auth_pword\": \"s3cr3t-basic-pass\",\n \"webhook_attributes_attributes\": [\n {\n \"attrib_type\": \"header\",\n \"key\": \"X-Source-System\",\n \"value\": \"procurementexpress\"\n },\n {\n \"attrib_type\": \"root\",\n \"key\": \"tenant\",\n \"value\": \"acme-corp\"\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ ] }, { "name": "Update or archive a webhook subscription", "request": { "method": "PUT", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v3/webhooks/3", "host": [ "{{base_url}}" ], "path": [ "api", "v3", "webhooks", "3" ], "query": [ ] }, "body": { "mode": "raw", "raw": "{\n \"webhook\": {\n \"name\": \"ERP purchase order feed (v3, webhooks_internal) - approvals only\",\n \"event_type\": [\n \"po_approved\",\n \"po_cancelled\"\n ],\n \"basic_auth_pword\": \"\",\n \"webhook_attributes_attributes\": [\n {\n \"id\": 3,\n \"attrib_type\": \"header\",\n \"key\": \"X-Source-System\",\n \"value\": \"pex-production\"\n },\n {\n \"attrib_type\": \"root\",\n \"key\": \"tenant\",\n \"value\": \"acme-corp\"\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ ] } ] } ] }, { "name": "V1 (authentication_token)", "item": [ { "name": "Authentication", "item": [ { "name": "Sign in (V1)", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/login", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "login" ], "query": [ ] }, "body": { "mode": "raw", "raw": "{\n \"email\": \"lee.login@example.com\",\n \"password\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ ] }, { "name": "Verify a one-time code", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/verify_otp", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "verify_otp" ], "query": [ ] }, "body": { "mode": "raw", "raw": "{\n \"email\": \"olivia.otp@example.com\",\n \"otp_attempt\": \"835374\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ ] }, { "name": "Resend the one-time code", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/resend_otp", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "resend_otp" ], "query": [ ] }, "body": { "mode": "raw", "raw": "{\n \"email\": \"olivia.otp@example.com\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ ] }, { "name": "Sign out (V1)", "request": { "method": "POST", "header": [ { "key": "authentication_token", "value": "{{authentication_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/logout", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "logout" ], "query": [ ] } }, "response": [ ] }, { "name": "Request a password reset e-mail", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/reset_password", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "reset_password" ], "query": [ ] }, "body": { "mode": "raw", "raw": "{\n \"email\": \"lee.login@example.com\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ ] } ] }, { "name": "Approval Flows", "item": [ { "name": "List approval flows", "request": { "method": "GET", "header": [ { "key": "authentication_token", "value": "{{authentication_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" } ], "url": { "raw": "{{base_url}}/api/v1/approval_flows?per_page=10", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "approval_flows" ], "query": [ { "key": "per_page", "value": "10" } ] } }, "response": [ ] }, { "name": "Get an approval flow", "request": { "method": "GET", "header": [ { "key": "authentication_token", "value": "{{authentication_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" } ], "url": { "raw": "{{base_url}}/api/v1/approval_flows/1", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "approval_flows", "1" ], "query": [ ] } }, "response": [ ] }, { "name": "Create an approval flow", "request": { "method": "POST", "header": [ { "key": "authentication_token", "value": "{{authentication_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/approval_flows", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "approval_flows" ], "query": [ ] }, "body": { "mode": "raw", "raw": "{\n \"approval_flow\": {\n \"name\": \"Lab PO routing v1\",\n \"document_type\": \"purchase_order\",\n \"self_approval_allowed\": false,\n \"approval_conditions_attributes\": [\n {\n \"property\": \"department\",\n \"operator\": \"equals\",\n \"value\": \"5\"\n }\n ],\n \"approval_steps_attributes\": [\n {\n \"step_no\": 1,\n \"all_should_approve\": false,\n \"approval_step_approvers_attributes\": [\n {\n \"user_id\": 50000\n }\n ]\n },\n {\n \"step_no\": 2,\n \"all_should_approve\": true,\n \"approval_step_approvers_attributes\": [\n {\n \"user_id\": 40000\n },\n {\n \"user_id\": 50000\n }\n ],\n \"approval_conditions_attributes\": [\n {\n \"property\": \"gross_amount\",\n \"operator\": \"greater_than\",\n \"value\": \"1000\"\n }\n ]\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ ] }, { "name": "Update an approval flow", "request": { "method": "PUT", "header": [ { "key": "authentication_token", "value": "{{authentication_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/approval_flows/1", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "approval_flows", "1" ], "query": [ ] }, "body": { "mode": "raw", "raw": "{\n \"approval_flow\": {\n \"name\": \"Lab PO routing v1 - updated\",\n \"approval_steps_attributes\": [\n {\n \"id\": 2,\n \"approval_step_approvers_attributes\": [\n {\n \"id\": 3,\n \"_destroy\": true\n }\n ],\n \"approval_conditions_attributes\": [\n {\n \"id\": 1,\n \"value\": \"2500\"\n }\n ]\n },\n {\n \"step_no\": 3,\n \"all_should_approve\": false,\n \"approval_step_approvers_attributes\": [\n {\n \"user_id\": 50000\n }\n ],\n \"approval_conditions_attributes\": [\n {\n \"property\": \"gross_amount\",\n \"operator\": \"greater_than\",\n \"value\": \"10000\"\n }\n ]\n }\n ],\n \"approval_conditions_attributes\": [\n {\n \"property\": \"supplier\",\n \"operator\": \"is_any_of\",\n \"value\": \"1,2,3\"\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ ] }, { "name": "Delete an approval flow", "request": { "method": "DELETE", "header": [ { "key": "authentication_token", "value": "{{authentication_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" } ], "url": { "raw": "{{base_url}}/api/v1/approval_flows/5", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "approval_flows", "5" ], "query": [ ] } }, "response": [ ] }, { "name": "Archive an approval flow", "request": { "method": "PUT", "header": [ { "key": "authentication_token", "value": "{{authentication_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" } ], "url": { "raw": "{{base_url}}/api/v1/approval_flows/7/archive", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "approval_flows", "7", "archive" ], "query": [ ] } }, "response": [ ] }, { "name": "Publish an approval flow", "request": { "method": "PATCH", "header": [ { "key": "authentication_token", "value": "{{authentication_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" } ], "url": { "raw": "{{base_url}}/api/v1/approval_flows/1/publish", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "approval_flows", "1", "publish" ], "query": [ ] } }, "response": [ ] }, { "name": "Unpublish an approval flow", "request": { "method": "PATCH", "header": [ { "key": "authentication_token", "value": "{{authentication_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" } ], "url": { "raw": "{{base_url}}/api/v1/approval_flows/1/unpublish", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "approval_flows", "1", "unpublish" ], "query": [ ] } }, "response": [ ] }, { "name": "List the runs of an approval flow", "request": { "method": "GET", "header": [ { "key": "authentication_token", "value": "{{authentication_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" } ], "url": { "raw": "{{base_url}}/api/v1/approval_flows/1/runs", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "approval_flows", "1", "runs" ], "query": [ ] } }, "response": [ ] }, { "name": "Get one run of an approval flow", "request": { "method": "GET", "header": [ { "key": "authentication_token", "value": "{{authentication_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" } ], "url": { "raw": "{{base_url}}/api/v1/approval_flows/1/show_entity?entity_id=1", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "approval_flows", "1", "show_entity" ], "query": [ { "key": "entity_id", "value": "1" } ] } }, "response": [ ] }, { "name": "List the versions of an approval flow", "request": { "method": "GET", "header": [ { "key": "authentication_token", "value": "{{authentication_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" } ], "url": { "raw": "{{base_url}}/api/v1/approval_flows/1/versions", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "approval_flows", "1", "versions" ], "query": [ ] } }, "response": [ ] }, { "name": "Get a version of an approval flow", "request": { "method": "GET", "header": [ { "key": "authentication_token", "value": "{{authentication_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" } ], "url": { "raw": "{{base_url}}/api/v1/approval_flows/1/version_details?version_id=55", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "approval_flows", "1", "version_details" ], "query": [ { "key": "version_id", "value": "55" } ] } }, "response": [ ] }, { "name": "Rerun approval flows for documents", "request": { "method": "POST", "header": [ { "key": "authentication_token", "value": "{{authentication_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/approval_flows/rerun_approval_flows", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "approval_flows", "rerun_approval_flows" ], "query": [ ] }, "body": { "mode": "raw", "raw": "{\n \"order_ids\": [\n 47\n ],\n \"invoice_ids\": [\n 22\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ ] }, { "name": "Export approval flows to Excel", "request": { "method": "GET", "header": [ { "key": "authentication_token", "value": "{{authentication_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" } ], "url": { "raw": "{{base_url}}/api/v1/approval_flows/export", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "approval_flows", "export" ], "query": [ ] } }, "response": [ ] } ] }, { "name": "Budgets", "item": [ { "name": "List budgets", "request": { "method": "GET", "header": [ { "key": "authentication_token", "value": "{{authentication_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" } ], "url": { "raw": "{{base_url}}/api/v1/budgets?department_id=3", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "budgets" ], "query": [ { "key": "department_id", "value": "3" } ] } }, "response": [ ] }, { "name": "Get a budget", "request": { "method": "GET", "header": [ { "key": "authentication_token", "value": "{{authentication_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" } ], "url": { "raw": "{{base_url}}/api/v1/budgets/1", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "budgets", "1" ], "query": [ ] } }, "response": [ ] }, { "name": "Create a budget", "request": { "method": "POST", "header": [ { "key": "authentication_token", "value": "{{authentication_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/budgets", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "budgets" ], "query": [ ] }, "body": { "mode": "raw", "raw": "{\n \"budget\": {\n \"name\": \"Facilities FY27\",\n \"amount\": 12000,\n \"cost_code\": \"FAC-27\",\n \"cost_type\": \"Opex\",\n \"start_date\": \"10/01/2026\",\n \"end_date\": \"09/30/2027\",\n \"department_ids\": [\n 4\n ],\n \"approver_ids\": [\n 40000,\n 50000\n ],\n \"chart_of_account_id\": 1,\n \"allow_anyone_to_approve_a_po\": false\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ ] }, { "name": "Update a budget", "request": { "method": "PUT", "header": [ { "key": "authentication_token", "value": "{{authentication_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/budgets/5", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "budgets", "5" ], "query": [ ] }, "body": { "mode": "raw", "raw": "{\n \"budget\": {\n \"amount\": 15000,\n \"end_date\": \"12/31/2027\",\n \"approver_ids\": [\n 40000\n ],\n \"department_ids\": [\n 4,\n 2\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ ] } ] }, { "name": "Companies", "item": [ { "name": "List companies", "request": { "method": "GET", "header": [ { "key": "authentication_token", "value": "{{authentication_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" } ], "url": { "raw": "{{base_url}}/api/v1/companies", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "companies" ], "query": [ ] } }, "response": [ ] }, { "name": "Get the current company", "request": { "method": "GET", "header": [ { "key": "authentication_token", "value": "{{authentication_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" } ], "url": { "raw": "{{base_url}}/api/v1/companies/details", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "companies", "details" ], "query": [ ] } }, "response": [ ] }, { "name": "Get a company", "request": { "method": "GET", "header": [ { "key": "authentication_token", "value": "{{authentication_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" } ], "url": { "raw": "{{base_url}}/api/v1/companies/20000", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "companies", "20000" ], "query": [ ] } }, "response": [ ] }, { "name": "Create a company", "request": { "method": "POST", "header": [ { "key": "authentication_token", "value": "{{authentication_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/companies", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "companies" ], "query": [ ] }, "body": { "mode": "raw", "raw": "{\n \"company\": {\n \"name\": \"Globex Subsidiary\",\n \"department\": \"Finance\",\n \"gross_or_net_config\": \"net\",\n \"default_tax_rate\": 0,\n \"company_setting_attributes\": {\n \"currency_id\": 2000,\n \"date_format\": \"%Y-%m-%d\",\n \"tax_label\": \"VAT\"\n },\n \"supported_currency_ids\": [\n 2000,\n 1000\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ ] }, { "name": "List approvers", "request": { "method": "GET", "header": [ { "key": "authentication_token", "value": "{{authentication_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" } ], "url": { "raw": "{{base_url}}/api/v1/companies/approvers", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "companies", "approvers" ], "query": [ ] } }, "response": [ ] }, { "name": "List all approvers", "request": { "method": "GET", "header": [ { "key": "authentication_token", "value": "{{authentication_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" } ], "url": { "raw": "{{base_url}}/api/v1/companies/all_approvers", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "companies", "all_approvers" ], "query": [ ] } }, "response": [ ] }, { "name": "List employees", "request": { "method": "GET", "header": [ { "key": "authentication_token", "value": "{{authentication_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" } ], "url": { "raw": "{{base_url}}/api/v1/companies/employees", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "companies", "employees" ], "query": [ ] } }, "response": [ ] }, { "name": "Get the invite limit", "request": { "method": "GET", "header": [ { "key": "authentication_token", "value": "{{authentication_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" } ], "url": { "raw": "{{base_url}}/api/v1/companies/invite_limit_left", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "companies", "invite_limit_left" ], "query": [ ] } }, "response": [ ] }, { "name": "List the company's chart of accounts", "request": { "method": "GET", "header": [ { "key": "authentication_token", "value": "{{authentication_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" } ], "url": { "raw": "{{base_url}}/api/v1/companies/chart_of_accounts", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "companies", "chart_of_accounts" ], "query": [ ] } }, "response": [ ] }, { "name": "Invite a user", "request": { "method": "POST", "header": [ { "key": "authentication_token", "value": "{{authentication_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/companies/send_user_invite", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "companies", "send_user_invite" ], "query": [ ] }, "body": { "mode": "raw", "raw": "{\n \"invite_user\": {\n \"email\": \"new.hire+v1@example.com\",\n \"name\": \"Nora Hire\",\n \"roles\": [\n \"approver\",\n \"teammember\"\n ],\n \"approval_limit\": 2500,\n \"department_ids\": [\n 2,\n 3\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ ] } ] }, { "name": "Compliance", "item": [ { "name": "List policies", "request": { "method": "GET", "header": [ { "key": "authentication_token", "value": "{{authentication_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" } ], "url": { "raw": "{{base_url}}/api/v1/policies", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "policies" ], "query": [ ] } }, "response": [ ] }, { "name": "Get a policy", "request": { "method": "GET", "header": [ { "key": "authentication_token", "value": "{{authentication_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" } ], "url": { "raw": "{{base_url}}/api/v1/policies/1", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "policies", "1" ], "query": [ ] } }, "response": [ ] }, { "name": "Create a policy", "request": { "method": "POST", "header": [ { "key": "authentication_token", "value": "{{authentication_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/policies", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "policies" ], "query": [ ] }, "body": { "mode": "raw", "raw": "{\n \"policy\": {\n \"name\": \"Competitive quotes over $5,000\",\n \"description\": \"Purchases between $5,000 and $250,000 need three written quotes.\",\n \"status\": \"active\",\n \"scope\": \"budget_specific\",\n \"category\": \"threshold\",\n \"budget_ids\": [\n 1\n ],\n \"min_amount\": 5000,\n \"max_amount\": 250000,\n \"min_quotes_required\": 3,\n \"required_attachments\": [\n \"quote\"\n ],\n \"content\": \"Any purchase of $5,000 or more charged to an engineering hardware budget must be supported by three written quotes from independent suppliers. Each quote must show the supplier name, item descriptions, unit prices and a validity date.\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ ] }, { "name": "Update a policy", "request": { "method": "PUT", "header": [ { "key": "authentication_token", "value": "{{authentication_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/policies/1", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "policies", "1" ], "query": [ ] }, "body": { "mode": "raw", "raw": "{\n \"policy\": {\n \"name\": \"Competitive quotes over $2,500\",\n \"min_amount\": 2500,\n \"description\": \"Purchases between $2,500 and $250,000 need three written quotes.\",\n \"content\": \"Any purchase of $2,500 or more charged to an engineering hardware or office supplies budget must be supported by three written quotes from independent suppliers. Each quote must show the supplier name, item descriptions, unit prices and a validity date.\",\n \"budget_ids\": [\n 1,\n 3\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ ] }, { "name": "Delete a policy", "request": { "method": "DELETE", "header": [ { "key": "authentication_token", "value": "{{authentication_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" } ], "url": { "raw": "{{base_url}}/api/v1/policies/5", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "policies", "5" ], "query": [ ] } }, "response": [ ] }, { "name": "List policy templates", "request": { "method": "GET", "header": [ { "key": "authentication_token", "value": "{{authentication_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" } ], "url": { "raw": "{{base_url}}/api/v1/policy_templates", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "policy_templates" ], "query": [ ] } }, "response": [ ] }, { "name": "Scan a purchase order", "request": { "method": "POST", "header": [ { "key": "authentication_token", "value": "{{authentication_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/compliance/check", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "compliance", "check" ], "query": [ ] }, "body": { "mode": "raw", "raw": "{\n \"compliance_check\": {\n \"purchase_order_id\": 21,\n \"budget_id\": 1,\n \"budget_name\": \"Engineering Hardware FY26\",\n \"total_amount\": 12800,\n \"supplier\": \"Contoso Hardware\",\n \"items\": [\n {\n \"description\": \"14-inch developer laptop, 32GB RAM\",\n \"quantity\": 4,\n \"unit_price\": 3200\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ ] }, { "name": "Scan several purchase orders", "request": { "method": "POST", "header": [ { "key": "authentication_token", "value": "{{authentication_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/compliance/bulk_check", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "compliance", "bulk_check" ], "query": [ ] }, "body": { "mode": "raw", "raw": "{\n \"purchase_order_ids\": [\n 23,\n 24,\n 25,\n 26\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ ] }, { "name": "Get your latest bulk scan", "request": { "method": "GET", "header": [ { "key": "authentication_token", "value": "{{authentication_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" } ], "url": { "raw": "{{base_url}}/api/v1/compliance/bulk_check_status", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "compliance", "bulk_check_status" ], "query": [ ] } }, "response": [ ] }, { "name": "List bulk scan history", "request": { "method": "GET", "header": [ { "key": "authentication_token", "value": "{{authentication_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" } ], "url": { "raw": "{{base_url}}/api/v1/compliance/scan_history", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "compliance", "scan_history" ], "query": [ ] } }, "response": [ ] }, { "name": "Get a bulk scan", "request": { "method": "GET", "header": [ { "key": "authentication_token", "value": "{{authentication_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" } ], "url": { "raw": "{{base_url}}/api/v1/compliance/scan_history/1", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "compliance", "scan_history", "1" ], "query": [ ] } }, "response": [ ] }, { "name": "Justify a violation", "request": { "method": "POST", "header": [ { "key": "authentication_token", "value": "{{authentication_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/compliance/justify", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "compliance", "justify" ], "query": [ ] }, "body": { "mode": "raw", "raw": "{\n \"violation_id\": 1,\n \"justification_reason\": \"Contoso is our sole authorised reseller for this laptop model under the 2026 hardware framework agreement, so competing quotes are not available.\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ ] }, { "name": "Generate a price reasonableness memo", "request": { "method": "POST", "header": [ { "key": "authentication_token", "value": "{{authentication_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/compliance/generate_memo", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "compliance", "generate_memo" ], "query": [ ] }, "body": { "mode": "raw", "raw": "{\n \"memo_request\": {\n \"violation_id\": 1,\n \"item_description\": \"4 x 14-inch developer laptops, 32GB RAM\",\n \"selected_vendor\": \"Contoso Hardware\",\n \"selected_price\": 12800,\n \"selection_rationale\": \"best_value\",\n \"market_basis\": \"competitive_quotes\",\n \"alternatives_considered\": [\n {\n \"vendor\": \"Northwind Office Supplies\",\n \"price\": 13600,\n \"notes\": \"Same model, 3-week lead time\"\n },\n {\n \"vendor\": \"Globex Logistics\",\n \"price\": 12950,\n \"notes\": \"Refurbished units only\"\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ ] }, { "name": "Create an evidence pack", "request": { "method": "POST", "header": [ { "key": "authentication_token", "value": "{{authentication_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/compliance/evidence_packs", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "compliance", "evidence_packs" ], "query": [ ] }, "body": { "mode": "raw", "raw": "{\n \"compliance_check_id\": 4\n}", "options": { "raw": { "language": "json" } } } }, "response": [ ] }, { "name": "Get an evidence pack", "request": { "method": "GET", "header": [ { "key": "authentication_token", "value": "{{authentication_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" } ], "url": { "raw": "{{base_url}}/api/v1/compliance/evidence_packs/1", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "compliance", "evidence_packs", "1" ], "query": [ ] } }, "response": [ ] }, { "name": "Download an evidence pack", "request": { "method": "GET", "header": [ { "key": "authentication_token", "value": "{{authentication_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" } ], "url": { "raw": "{{base_url}}/api/v1/compliance/evidence_packs/1/download", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "compliance", "evidence_packs", "1", "download" ], "query": [ ] } }, "response": [ ] }, { "name": "Rebuild an evidence pack", "request": { "method": "POST", "header": [ { "key": "authentication_token", "value": "{{authentication_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" } ], "url": { "raw": "{{base_url}}/api/v1/compliance/evidence_packs/1/regenerate", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "compliance", "evidence_packs", "1", "regenerate" ], "query": [ ] } }, "response": [ ] } ] }, { "name": "Currencies", "item": [ { "name": "List the company's currencies", "request": { "method": "GET", "header": [ { "key": "authentication_token", "value": "{{authentication_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" } ], "url": { "raw": "{{base_url}}/api/v1/currencies", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "currencies" ], "query": [ ] } }, "response": [ ] }, { "name": "List all currencies", "request": { "method": "GET", "header": [ { "key": "authentication_token", "value": "{{authentication_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" } ], "url": { "raw": "{{base_url}}/api/v1/all_currencies", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "all_currencies" ], "query": [ ] } }, "response": [ ] } ] }, { "name": "Custom Fields", "item": [ { "name": "List custom fields", "request": { "method": "GET", "header": [ { "key": "authentication_token", "value": "{{authentication_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" } ], "url": { "raw": "{{base_url}}/api/v1/custom_fields", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "custom_fields" ], "query": [ ] } }, "response": [ ] }, { "name": "Get a custom field", "request": { "method": "GET", "header": [ { "key": "authentication_token", "value": "{{authentication_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" } ], "url": { "raw": "{{base_url}}/api/v1/custom_fields/2", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "custom_fields", "2" ], "query": [ ] } }, "response": [ ] }, { "name": "Create a custom field", "request": { "method": "POST", "header": [ { "key": "authentication_token", "value": "{{authentication_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/custom_fields", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "custom_fields" ], "query": [ ] }, "body": { "mode": "raw", "raw": "{\n \"custom_field\": {\n \"name\": \"Delivery priority\",\n \"field_type\": \"select\",\n \"option_list\": \"Standard\\nExpress\\nOvernight\",\n \"default_value\": \"Standard\",\n \"required\": true,\n \"access_level\": \"everyone\",\n \"on_line_item\": false,\n \"display_on_pdf\": true,\n \"editable_after_approval\": true\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ ] }, { "name": "Update a custom field", "request": { "method": "PUT", "header": [ { "key": "authentication_token", "value": "{{authentication_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/custom_fields/6", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "custom_fields", "6" ], "query": [ ] }, "body": { "mode": "raw", "raw": "{\n \"custom_field\": {\n \"name\": \"Requested delivery window\",\n \"field_type\": \"select\",\n \"option_list\": \"Morning\\nAfternoon\\nEvening\",\n \"default_value\": \"Morning\",\n \"access_level\": \"approvers_and_finance\",\n \"display_on_pdf\": false\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ ] }, { "name": "Delete (archive) a custom field", "request": { "method": "DELETE", "header": [ { "key": "authentication_token", "value": "{{authentication_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" } ], "url": { "raw": "{{base_url}}/api/v1/custom_fields/6", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "custom_fields", "6" ], "query": [ ] } }, "response": [ ] }, { "name": "Reorder custom fields", "request": { "method": "PATCH", "header": [ { "key": "authentication_token", "value": "{{authentication_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/custom_fields/update_positions", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "custom_fields", "update_positions" ], "query": [ ] }, "body": { "mode": "raw", "raw": "{\n \"positions\": {\n \"6\": 5,\n \"5\": 6\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ ] }, { "name": "Set a custom field value", "request": { "method": "POST", "header": [ { "key": "authentication_token", "value": "{{authentication_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/custom_field_values", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "custom_field_values" ], "query": [ ] }, "body": { "mode": "raw", "raw": "{\n \"custom_field_value\": {\n \"id\": 43,\n \"custom_field_id\": 2,\n \"purchase_order_id\": 11,\n \"value\": \"CC-300 Operations\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ ] } ] }, { "name": "Departments", "item": [ { "name": "List departments", "request": { "method": "GET", "header": [ { "key": "authentication_token", "value": "{{authentication_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" } ], "url": { "raw": "{{base_url}}/api/v1/departments", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "departments" ], "query": [ ] } }, "response": [ ] }, { "name": "Get a department", "request": { "method": "GET", "header": [ { "key": "authentication_token", "value": "{{authentication_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" } ], "url": { "raw": "{{base_url}}/api/v1/departments/2", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "departments", "2" ], "query": [ ] } }, "response": [ ] }, { "name": "Create a department", "request": { "method": "POST", "header": [ { "key": "authentication_token", "value": "{{authentication_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/departments", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "departments" ], "query": [ ] }, "body": { "mode": "raw", "raw": "{\n \"department\": {\n \"name\": \"Procurement\",\n \"contact_person\": \"Jane Doe\",\n \"phone_number\": \"+1 555 0130\",\n \"email\": \"procurement@example.com\",\n \"address\": \"300 Supply Road, Springfield, IL 62701\",\n \"tax_number\": \"US-PR-003\",\n \"budget_ids\": [\n 3\n ],\n \"user_ids\": [\n 40000\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ ] }, { "name": "Update a department", "request": { "method": "PUT", "header": [ { "key": "authentication_token", "value": "{{authentication_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/departments/16", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "departments", "16" ], "query": [ ] }, "body": { "mode": "raw", "raw": "{\n \"department\": {\n \"name\": \"Procurement & Sourcing\",\n \"contact_person\": \"Marco Rossi\",\n \"phone_number\": \"+1 555 0131\",\n \"budget_ids\": [\n\n ],\n \"user_ids\": [\n 40000\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ ] } ] }, { "name": "Invoices", "item": [ { "name": "List invoices", "request": { "method": "GET", "header": [ { "key": "authentication_token", "value": "{{authentication_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" } ], "url": { "raw": "{{base_url}}/api/v1/invoices?invoice_statuses_filter=settled&supplier_id%5B%5D=2&sort=invoices.invoice_number&direction=asc", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "invoices" ], "query": [ { "key": "invoice_statuses_filter", "value": "settled" }, { "key": "supplier_id[]", "value": "2" }, { "key": "sort", "value": "invoices.invoice_number" }, { "key": "direction", "value": "asc" } ] } }, "response": [ ] }, { "name": "Get an invoice", "request": { "method": "GET", "header": [ { "key": "authentication_token", "value": "{{authentication_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" } ], "url": { "raw": "{{base_url}}/api/v1/invoices/1", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "invoices", "1" ], "query": [ ] } }, "response": [ ] }, { "name": "Create an invoice", "request": { "method": "POST", "header": [ { "key": "authentication_token", "value": "{{authentication_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/invoices", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "invoices" ], "query": [ ] }, "body": { "mode": "raw", "raw": "{\n \"invoice\": {\n \"invoice_number\": \"CH-2026-1001\",\n \"supplier_id\": 2,\n \"currency_id\": 2000,\n \"issue_date\": \"2026-10-20\",\n \"received_date\": \"2026-10-21\",\n \"due_date\": \"2026-11-19\",\n \"gross_amount\": \"990.00\",\n \"invoice_line_items_attributes\": [\n {\n \"sequence_no\": 1,\n \"description\": \"USB-C dock\",\n \"quantity\": 2,\n \"unit_price\": 150,\n \"vat\": 10,\n \"net_amount\": 300,\n \"tax_rate_id\": 4,\n \"purchase_order_id\": 1,\n \"purchase_order_item_id\": 1\n },\n {\n \"sequence_no\": 2,\n \"description\": \"27in monitor\",\n \"quantity\": 2,\n \"unit_price\": 300,\n \"vat\": 10,\n \"net_amount\": 600,\n \"tax_rate_id\": 4,\n \"purchase_order_id\": 1,\n \"purchase_order_item_id\": 2\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ ] }, { "name": "Update an invoice", "request": { "method": "PUT", "header": [ { "key": "authentication_token", "value": "{{authentication_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/invoices/1", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "invoices", "1" ], "query": [ ] }, "body": { "mode": "raw", "raw": "{\n \"invoice\": {\n \"due_date\": \"2026-12-04\",\n \"payment_term_id\": 3,\n \"custom_field_values_attributes\": [\n {\n \"custom_field_id\": 4,\n \"value\": \"AP-2026-10-B\"\n }\n ],\n \"invoice_line_items_attributes\": [\n {\n \"id\": 1,\n \"quantity\": 3,\n \"net_amount\": 450\n },\n {\n \"id\": 2,\n \"_destroy\": true\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ ] }, { "name": "List purchase orders to invoice", "request": { "method": "GET", "header": [ { "key": "authentication_token", "value": "{{authentication_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" } ], "url": { "raw": "{{base_url}}/api/v1/invoices/purchase_order_list?supplier_id=2&per_page=2&selected_ids=10", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "invoices", "purchase_order_list" ], "query": [ { "key": "supplier_id", "value": "2" }, { "key": "per_page", "value": "2" }, { "key": "selected_ids", "value": "10" } ] } }, "response": [ ] }, { "name": "List purchase order lines to invoice", "request": { "method": "GET", "header": [ { "key": "authentication_token", "value": "{{authentication_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" } ], "url": { "raw": "{{base_url}}/api/v1/invoices/purchase_order_item_list?purchase_order_ids%5B%5D=1&purchase_order_ids%5B%5D=5", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "invoices", "purchase_order_item_list" ], "query": [ { "key": "purchase_order_ids[]", "value": "1" }, { "key": "purchase_order_ids[]", "value": "5" } ] } }, "response": [ ] }, { "name": "Comment on an invoice", "request": { "method": "POST", "header": [ { "key": "authentication_token", "value": "{{authentication_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/invoices/1/create_comment", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "invoices", "1", "create_comment" ], "query": [ ] }, "body": { "mode": "raw", "raw": "{\n \"invoice_comments\": {\n \"comment\": \"Quantity corrected to 3 docks per the delivery note. See https://example.com/dn/4471\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ ] }, { "name": "Accept an invoice awaiting review", "request": { "method": "PUT", "header": [ { "key": "authentication_token", "value": "{{authentication_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" } ], "url": { "raw": "{{base_url}}/api/v1/invoices/14/accept", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "invoices", "14", "accept" ], "query": [ ] } }, "response": [ ] }, { "name": "Approve an invoice", "request": { "method": "PUT", "header": [ { "key": "authentication_token", "value": "{{authentication_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" } ], "url": { "raw": "{{base_url}}/api/v1/invoices/6/approve", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "invoices", "6", "approve" ], "query": [ ] } }, "response": [ ] }, { "name": "Reject an invoice", "request": { "method": "PUT", "header": [ { "key": "authentication_token", "value": "{{authentication_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" } ], "url": { "raw": "{{base_url}}/api/v1/invoices/8/reject", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "invoices", "8", "reject" ], "query": [ ] } }, "response": [ ] }, { "name": "Cancel an invoice", "request": { "method": "PUT", "header": [ { "key": "authentication_token", "value": "{{authentication_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" } ], "url": { "raw": "{{base_url}}/api/v1/invoices/10/cancel", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "invoices", "10", "cancel" ], "query": [ ] } }, "response": [ ] }, { "name": "Archive an invoice", "request": { "method": "PUT", "header": [ { "key": "authentication_token", "value": "{{authentication_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" } ], "url": { "raw": "{{base_url}}/api/v1/invoices/12/archive", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "invoices", "12", "archive" ], "query": [ ] } }, "response": [ ] }, { "name": "Unarchive an invoice", "request": { "method": "PUT", "header": [ { "key": "authentication_token", "value": "{{authentication_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" } ], "url": { "raw": "{{base_url}}/api/v1/invoices/12/dearchive", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "invoices", "12", "dearchive" ], "query": [ ] } }, "response": [ ] }, { "name": "Rerun the approval flow of an invoice", "request": { "method": "POST", "header": [ { "key": "authentication_token", "value": "{{authentication_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" } ], "url": { "raw": "{{base_url}}/api/v1/invoices/23/rerun_approval_flow", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "invoices", "23", "rerun_approval_flow" ], "query": [ ] } }, "response": [ ] }, { "name": "Scan an invoice document", "request": { "method": "POST", "header": [ { "key": "authentication_token", "value": "{{authentication_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" } ], "url": { "raw": "{{base_url}}/api/v1/digital_invoices", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "digital_invoices" ], "query": [ ] }, "body": { "mode": "formdata", "formdata": [ { "key": "upload_type", "value": "invoice", "type": "text" }, { "key": "file", "type": "file", "src": "invoice-CH-2026-1003.pdf" } ] } }, "response": [ ] } ] }, { "name": "Payments", "item": [ { "name": "Get a payment", "request": { "method": "GET", "header": [ { "key": "authentication_token", "value": "{{authentication_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" } ], "url": { "raw": "{{base_url}}/api/v1/npayments/2", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "npayments", "2" ], "query": [ ] } }, "response": [ ] }, { "name": "Record a payment", "request": { "method": "POST", "header": [ { "key": "authentication_token", "value": "{{authentication_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/npayments", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "npayments" ], "query": [ ] }, "body": { "mode": "raw", "raw": "{\n \"npayment\": {\n \"reference\": \"ACH-20261021-01\",\n \"ptype\": \"bank_transfer\",\n \"payment_mode\": \"normal\",\n \"date\": \"2026-10-21\",\n \"amount\": 165.0,\n \"supplier_id\": 2,\n \"currency_id\": 2000,\n \"npayment_invoices_attributes\": [\n {\n \"invoice_id\": 16,\n \"gross_amount\": 165.0\n }\n ],\n \"npayment_comments_attributes\": [\n {\n \"comment\": \"Paid by ACH from operating account\"\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ ] }, { "name": "Mark a purchase order as paid", "request": { "method": "POST", "header": [ { "key": "authentication_token", "value": "{{authentication_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/purchase_orders/6/payments", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "purchase_orders", "6", "payments" ], "query": [ ] }, "body": { "mode": "raw", "raw": "{\n \"payment\": {\n \"amount\": 1306.5,\n \"note\": \"Paid in full by wire, ref WIRE-88213\",\n \"purchase_order_item_payments_attributes\": [\n {\n \"purchase_order_item_id\": 10,\n \"amount\": 653.25\n },\n {\n \"purchase_order_item_id\": 11,\n \"amount\": 653.25\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ ] } ] }, { "name": "Products", "item": [ { "name": "List products", "request": { "method": "GET", "header": [ { "key": "authentication_token", "value": "{{authentication_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" } ], "url": { "raw": "{{base_url}}/api/v1/products?supplier_id=5", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "products" ], "query": [ { "key": "supplier_id", "value": "5" } ] } }, "response": [ ] }, { "name": "Get a product", "request": { "method": "GET", "header": [ { "key": "authentication_token", "value": "{{authentication_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" } ], "url": { "raw": "{{base_url}}/api/v1/products/9", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "products", "9" ], "query": [ ] } }, "response": [ ] }, { "name": "List product SKUs", "request": { "method": "GET", "header": [ { "key": "authentication_token", "value": "{{authentication_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" } ], "url": { "raw": "{{base_url}}/api/v1/products/skus", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "products", "skus" ], "query": [ ] } }, "response": [ ] }, { "name": "Create a product", "request": { "method": "POST", "header": [ { "key": "authentication_token", "value": "{{authentication_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/products", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "products" ], "query": [ ] }, "body": { "mode": "raw", "raw": "{\n \"product\": {\n \"sku\": \"CHAIR-ERG-01\",\n \"description\": \"Ergonomic mesh chair\",\n \"unit_price\": 289.5,\n \"supplier_id\": 4,\n \"budget_id\": 3,\n \"tax_rate_id\": 4\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ ] }, { "name": "Bulk-create products for a supplier", "request": { "method": "POST", "header": [ { "key": "authentication_token", "value": "{{authentication_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/products/bulk_create", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "products", "bulk_create" ], "query": [ ] }, "body": { "mode": "raw", "raw": "{\n \"supplier_id\": 4,\n \"product\": {\n \"product_item_attributes\": [\n {\n \"sku\": \"DESK-LAMP-LED\",\n \"description\": \"LED desk lamp\",\n \"unit_price\": 39.0\n },\n {\n \"sku\": \"FOOTREST-01\",\n \"description\": \"Adjustable footrest\",\n \"unit_price\": 24.5\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ ] }, { "name": "Update a product", "request": { "method": "PUT", "header": [ { "key": "authentication_token", "value": "{{authentication_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/products/9", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "products", "9" ], "query": [ ] }, "body": { "mode": "raw", "raw": "{\n \"product\": {\n \"description\": \"Ergonomic mesh chair, black\",\n \"unit_price\": 275.0,\n \"tax_rate_id\": 5\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ ] } ] }, { "name": "Purchase Orders", "item": [ { "name": "List purchase orders", "request": { "method": "GET", "header": [ { "key": "authentication_token", "value": "{{authentication_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" } ], "url": { "raw": "{{base_url}}/api/v1/purchase_orders?budget_id=10", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "purchase_orders" ], "query": [ { "key": "budget_id", "value": "10" } ] } }, "response": [ ] }, { "name": "Get a purchase order", "request": { "method": "GET", "header": [ { "key": "authentication_token", "value": "{{authentication_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" } ], "url": { "raw": "{{base_url}}/api/v1/purchase_orders/19", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "purchase_orders", "19" ], "query": [ ] } }, "response": [ ] }, { "name": "New purchase order template", "request": { "method": "GET", "header": [ { "key": "authentication_token", "value": "{{authentication_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" } ], "url": { "raw": "{{base_url}}/api/v1/purchase_orders/new", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "purchase_orders", "new" ], "query": [ ] } }, "response": [ ] }, { "name": "Create a purchase order", "request": { "method": "POST", "header": [ { "key": "authentication_token", "value": "{{authentication_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/purchase_orders", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "purchase_orders" ], "query": [ ] }, "body": { "mode": "raw", "raw": "{\n \"commit\": \"Send\",\n \"purchase_order\": {\n \"supplier_id\": 2,\n \"department_id\": 2,\n \"currency_id\": 2000,\n \"notes\": \"Monitors and docks for the Q4 engineering hires\",\n \"purchase_order_items_attributes\": [\n {\n \"product_id\": 2,\n \"item_number\": \"MON-27\",\n \"description\": \"27-inch 4K monitor\",\n \"quantity\": 4,\n \"unit_price\": 329.99,\n \"budget_id\": 1,\n \"tax_rate_id\": 4,\n \"vat\": 8.875,\n \"custom_field_values_attributes\": [\n {\n \"custom_field_id\": 3,\n \"value\": \"AT-0441\"\n }\n ]\n },\n {\n \"product_id\": 3,\n \"item_number\": \"DOCK-USB-C\",\n \"description\": \"USB-C docking station\",\n \"quantity\": 4,\n \"unit_price\": 189.5,\n \"budget_id\": 1,\n \"tax_rate_id\": 4,\n \"vat\": 8.875\n }\n ],\n \"custom_field_values_attributes\": [\n {\n \"custom_field_id\": 1,\n \"value\": \"PRJ-2026-014\"\n },\n {\n \"custom_field_id\": 2,\n \"value\": \"CC-100 Engineering\"\n }\n ],\n \"approver_list\": [\n 50000\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ ] }, { "name": "Update a purchase order", "request": { "method": "PUT", "header": [ { "key": "authentication_token", "value": "{{authentication_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/purchase_orders/52", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "purchase_orders", "52" ], "query": [ ] }, "body": { "mode": "raw", "raw": "{\n \"commit\": \"Send\",\n \"purchase_order\": {\n \"notes\": \"Docking stations and a monitor for the design team, submitted for approval\",\n \"approver_list\": [\n 50000\n ],\n \"purchase_order_items_attributes\": [\n {\n \"id\": 73,\n \"quantity\": 3,\n \"custom_field_values_attributes\": [\n {\n \"id\": 179,\n \"custom_field_id\": 3,\n \"value\": \"AT-0502\"\n }\n ]\n },\n {\n \"product_id\": 2,\n \"item_number\": \"MON-27\",\n \"description\": \"27-inch 4K monitor\",\n \"quantity\": 1,\n \"unit_price\": 329.99,\n \"budget_id\": 1,\n \"tax_rate_id\": 4,\n \"vat\": 8.875\n }\n ],\n \"custom_field_values_attributes\": [\n {\n \"id\": 177,\n \"custom_field_id\": 1,\n \"value\": \"PRJ-2026-031\"\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ ] }, { "name": "Create purchase orders in bulk", "request": { "method": "POST", "header": [ { "key": "authentication_token", "value": "{{authentication_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/purchase_orders/bulk_save", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "purchase_orders", "bulk_save" ], "query": [ ] }, "body": { "mode": "raw", "raw": "{\n \"purchase_order\": {\n \"data\": [\n {\n \"_id\": \"erp-req-1001\",\n \"commit\": \"Send\",\n \"supplier_id\": 2,\n \"department_id\": 2,\n \"currency_id\": 2000,\n \"notes\": \"Docking stations for the support desk\",\n \"approver_list\": [\n 50000\n ],\n \"purchase_order_items_attributes\": [\n {\n \"product_id\": 3,\n \"item_number\": \"DOCK-USB-C\",\n \"description\": \"USB-C docking station\",\n \"quantity\": 2,\n \"unit_price\": 189.5,\n \"budget_id\": 1,\n \"tax_rate_id\": 4\n }\n ],\n \"custom_field_values_attributes\": [\n {\n \"custom_field_id\": 1,\n \"value\": \"PRJ-2026-051\"\n }\n ]\n },\n {\n \"_id\": \"erp-req-1002\",\n \"commit\": \"Draft\",\n \"supplier_id\": 1,\n \"department_id\": 3,\n \"currency_id\": 2000,\n \"notes\": \"Whiteboard markers, waiting on a quote\",\n \"purchase_order_items_attributes\": [\n {\n \"description\": \"Whiteboard markers, pack of 12\",\n \"quantity\": 4,\n \"unit_price\": 14.25,\n \"budget_id\": 2,\n \"tax_rate_id\": 4\n }\n ]\n },\n {\n \"_id\": \"erp-req-1003\",\n \"commit\": \"Send\",\n \"supplier_id\": 1,\n \"department_id\": 3,\n \"currency_id\": 2000,\n \"notes\": \"Row with no line items\",\n \"approver_list\": [\n 50000\n ]\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ ] }, { "name": "Approve a purchase order", "request": { "method": "POST", "header": [ { "key": "authentication_token", "value": "{{authentication_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/purchase_orders/32/approve", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "purchase_orders", "32", "approve" ], "query": [ ] }, "body": { "mode": "raw", "raw": "{\n \"token\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ ] }, { "name": "Reject a purchase order", "request": { "method": "POST", "header": [ { "key": "authentication_token", "value": "{{authentication_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/purchase_orders/35/reject", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "purchase_orders", "35", "reject" ], "query": [ ] }, "body": { "mode": "raw", "raw": "{\n \"token\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ ] }, { "name": "Override and approve a purchase order", "request": { "method": "POST", "header": [ { "key": "authentication_token", "value": "{{authentication_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" } ], "url": { "raw": "{{base_url}}/api/v1/purchase_orders/37/override_and_approve", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "purchase_orders", "37", "override_and_approve" ], "query": [ ] } }, "response": [ ] }, { "name": "Cancel a purchase order", "request": { "method": "POST", "header": [ { "key": "authentication_token", "value": "{{authentication_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" } ], "url": { "raw": "{{base_url}}/api/v1/purchase_orders/29/cancel", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "purchase_orders", "29", "cancel" ], "query": [ ] } }, "response": [ ] }, { "name": "Archive a purchase order", "request": { "method": "POST", "header": [ { "key": "authentication_token", "value": "{{authentication_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" } ], "url": { "raw": "{{base_url}}/api/v1/purchase_orders/43/archive", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "purchase_orders", "43", "archive" ], "query": [ ] } }, "response": [ ] }, { "name": "Delete a draft purchase order", "request": { "method": "DELETE", "header": [ { "key": "authentication_token", "value": "{{authentication_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" } ], "url": { "raw": "{{base_url}}/api/v1/purchase_orders/45/delete", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "purchase_orders", "45", "delete" ], "query": [ ] } }, "response": [ ] }, { "name": "Count my pending approvals", "request": { "method": "GET", "header": [ { "key": "authentication_token", "value": "{{authentication_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" } ], "url": { "raw": "{{base_url}}/api/v1/purchase_orders/pending_request_count", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "purchase_orders", "pending_request_count" ], "query": [ ] } }, "response": [ ] }, { "name": "Preview budget approvers", "request": { "method": "GET", "header": [ { "key": "authentication_token", "value": "{{authentication_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" } ], "url": { "raw": "{{base_url}}/api/v1/purchase_orders/auto_approvers_list?budget_ids%5B%5D=1&gross_total=2262.38", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "purchase_orders", "auto_approvers_list" ], "query": [ { "key": "budget_ids[]", "value": "1" }, { "key": "gross_total", "value": "2262.38" } ] } }, "response": [ ] }, { "name": "Preview approval-flow approvers", "request": { "method": "POST", "header": [ { "key": "authentication_token", "value": "{{authentication_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/purchase_orders/approver_list", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "purchase_orders", "approver_list" ], "query": [ ] }, "body": { "mode": "raw", "raw": "{\n \"test_mode\": true,\n \"approval_flow_id\": 1,\n \"purchase_order\": {\n \"supplier_id\": 2,\n \"department_id\": 5,\n \"currency_id\": 2000,\n \"purchase_order_items_attributes\": [\n {\n \"product_id\": 3,\n \"description\": \"USB-C docking station\",\n \"quantity\": 2,\n \"unit_price\": 189.5,\n \"budget_id\": 4,\n \"tax_rate_id\": 4,\n \"vat\": 8.875\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ ] } ] }, { "name": "Purchase Orders: Attachments", "item": [ { "name": "Upload a file to a purchase order", "request": { "method": "POST", "header": [ { "key": "authentication_token", "value": "{{authentication_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" } ], "url": { "raw": "{{base_url}}/api/v1/uploads/po", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "uploads", "po" ], "query": [ ] }, "body": { "mode": "formdata", "formdata": [ { "key": "po_id", "value": "11", "type": "text" }, { "key": "uploads_attributes[upload_token]", "value": "pofulfil-v1-dn-0001", "type": "text" }, { "key": "uploads_attributes[file]", "type": "file", "src": "delivery-note.pdf" } ] } }, "response": [ ] }, { "name": "Upload a file to a PO comment", "request": { "method": "POST", "header": [ { "key": "authentication_token", "value": "{{authentication_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" } ], "url": { "raw": "{{base_url}}/api/v1/uploads/poc", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "uploads", "poc" ], "query": [ ] }, "body": { "mode": "formdata", "formdata": [ { "key": "poc_id", "value": "53", "type": "text" }, { "key": "uploads_attributes[upload_token]", "value": "pofulfil-v1-photo-0001", "type": "text" }, { "key": "uploads_attributes[file]", "type": "file", "src": "damaged-box.png" } ] } }, "response": [ ] }, { "name": "Get upload status", "request": { "method": "GET", "header": [ { "key": "authentication_token", "value": "{{authentication_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" } ], "url": { "raw": "{{base_url}}/api/v1/uploads/status?upload_token=pofulfil-v1-dn-0001", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "uploads", "status" ], "query": [ { "key": "upload_token", "value": "pofulfil-v1-dn-0001" } ] } }, "response": [ ] } ] }, { "name": "Purchase Orders: Comments", "item": [ { "name": "Comment on a purchase order", "request": { "method": "POST", "header": [ { "key": "authentication_token", "value": "{{authentication_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/purchase_orders/11/comments", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "purchase_orders", "11", "comments" ], "query": [ ] }, "body": { "mode": "raw", "raw": "{\n \"comment\": \"Paper boxes arrived slightly damaged - marco.rossi@example.com can you hold the invoice until we confirm with Northwind? See https://example.com/claims/1234\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ ] } ] }, { "name": "Purchase Orders: Receiving & Delivery", "item": [ { "name": "Receive items", "request": { "method": "POST", "header": [ { "key": "authentication_token", "value": "{{authentication_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/purchase_orders/11/receiving_items", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "purchase_orders", "11", "receiving_items" ], "query": [ ] }, "body": { "mode": "raw", "raw": "{\n \"purchase_order\": {\n \"delivered_on\": \"10/20/2026\",\n \"notes\": \"First pallet arrived; markers complete, paper short by 6 boxes\",\n \"items\": [\n {\n \"id\": 20,\n \"quantity\": 4\n },\n {\n \"id\": 21,\n \"quantity\": 6\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ ] }, { "name": "Cancel received items", "request": { "method": "POST", "header": [ { "key": "authentication_token", "value": "{{authentication_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" } ], "url": { "raw": "{{base_url}}/api/v1/purchase_orders/13/cancel_receiving_items", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "purchase_orders", "13", "cancel_receiving_items" ], "query": [ ] } }, "response": [ ] }, { "name": "Complete delivery", "request": { "method": "POST", "header": [ { "key": "authentication_token", "value": "{{authentication_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" } ], "url": { "raw": "{{base_url}}/api/v1/purchase_orders/15/complete_delivery", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "purchase_orders", "15", "complete_delivery" ], "query": [ ] } }, "response": [ ] } ] }, { "name": "Purchase Orders: Sending to Suppliers", "item": [ { "name": "Send a purchase order to a supplier", "request": { "method": "POST", "header": [ { "key": "authentication_token", "value": "{{authentication_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/purchase_orders/11/forward", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "purchase_orders", "11", "forward" ], "query": [ ] }, "body": { "mode": "raw", "raw": "{\n \"emails\": \"orders@northwind.example.com\",\n \"cc\": \"accounts.payable@example.com\",\n \"email_subject\": \"Purchase order {PurchaseOrder.Number} from {Company.Name}\",\n \"note\": \"Dear {Supplier.Name},\\n\\nPlease find purchase order {PurchaseOrder.Number} attached, together with our delivery note and a photo of the damaged boxes.\\n\\nThanks,\\n{Requester.Name}\",\n \"uploads\": [\n 4,\n 8\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ ] }, { "name": "Save or update a send-to-supplier template", "request": { "method": "POST", "header": [ { "key": "authentication_token", "value": "{{authentication_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/purchase_orders/11/forward", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "purchase_orders", "11", "forward" ], "query": [ ] }, "body": { "mode": "raw", "raw": "{\n \"save_template\": true,\n \"template_name\": \"Delivery follow-up\",\n \"email_subject\": \"PO {PurchaseOrder.Number} - delivery schedule\",\n \"note\": \"Dear {Supplier.Name},\\n\\nPlease confirm the delivery date for purchase order {PurchaseOrder.Number}.\\n\\nThanks,\\n{Requester.Name}\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ ] }, { "name": "List send-to-supplier templates", "request": { "method": "GET", "header": [ { "key": "authentication_token", "value": "{{authentication_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" } ], "url": { "raw": "{{base_url}}/api/v1/send_to_supplier_templates", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "send_to_supplier_templates" ], "query": [ ] } }, "response": [ ] }, { "name": "Generate a purchase order PDF", "request": { "method": "GET", "header": [ { "key": "authentication_token", "value": "{{authentication_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" } ], "url": { "raw": "{{base_url}}/api/v1/purchase_orders/11/generate_pdf", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "purchase_orders", "11", "generate_pdf" ], "query": [ ] } }, "response": [ ] } ] }, { "name": "QuickBooks Online: Chart of Accounts", "item": [ { "name": "List chart of accounts", "request": { "method": "GET", "header": [ { "key": "authentication_token", "value": "{{authentication_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" } ], "url": { "raw": "{{base_url}}/api/v1/chart_of_accounts", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "chart_of_accounts" ], "query": [ ] } }, "response": [ ] }, { "name": "Get a chart of account", "request": { "method": "GET", "header": [ { "key": "authentication_token", "value": "{{authentication_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" } ], "url": { "raw": "{{base_url}}/api/v1/chart_of_accounts/2", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "chart_of_accounts", "2" ], "query": [ ] } }, "response": [ ] } ] }, { "name": "QuickBooks Online: Classes", "item": [ { "name": "List QuickBooks classes", "request": { "method": "GET", "header": [ { "key": "authentication_token", "value": "{{authentication_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" } ], "url": { "raw": "{{base_url}}/api/v1/qbo_classes", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "qbo_classes" ], "query": [ ] } }, "response": [ ] }, { "name": "Get a QuickBooks class", "request": { "method": "GET", "header": [ { "key": "authentication_token", "value": "{{authentication_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" } ], "url": { "raw": "{{base_url}}/api/v1/qbo_classes/1", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "qbo_classes", "1" ], "query": [ ] } }, "response": [ ] } ] }, { "name": "QuickBooks Online: Customers", "item": [ { "name": "List QuickBooks customers", "request": { "method": "GET", "header": [ { "key": "authentication_token", "value": "{{authentication_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" } ], "url": { "raw": "{{base_url}}/api/v1/qbo_customers", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "qbo_customers" ], "query": [ ] } }, "response": [ ] }, { "name": "Get a QuickBooks customer", "request": { "method": "GET", "header": [ { "key": "authentication_token", "value": "{{authentication_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" } ], "url": { "raw": "{{base_url}}/api/v1/qbo_customers/1", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "qbo_customers", "1" ], "query": [ ] } }, "response": [ ] } ] }, { "name": "SAM.gov Supplier Audit", "item": [ { "name": "Check a supplier against SAM.gov", "request": { "method": "POST", "header": [ { "key": "authentication_token", "value": "{{authentication_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/sam_gov/check", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "sam_gov", "check" ], "query": [ ] }, "body": { "mode": "raw", "raw": "{\n \"supplier_id\": 4,\n \"force\": false\n}", "options": { "raw": { "language": "json" } } } }, "response": [ ] }, { "name": "Get a supplier's latest SAM.gov check", "request": { "method": "GET", "header": [ { "key": "authentication_token", "value": "{{authentication_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" } ], "url": { "raw": "{{base_url}}/api/v1/sam_gov/status/4", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "sam_gov", "status", "4" ], "query": [ ] } }, "response": [ ] } ] }, { "name": "Suppliers", "item": [ { "name": "List suppliers", "request": { "method": "GET", "header": [ { "key": "authentication_token", "value": "{{authentication_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" } ], "url": { "raw": "{{base_url}}/api/v1/suppliers?search=sup-prod", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "suppliers" ], "query": [ { "key": "search", "value": "sup-prod" } ] } }, "response": [ ] }, { "name": "List the caller's most used suppliers", "request": { "method": "GET", "header": [ { "key": "authentication_token", "value": "{{authentication_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" } ], "url": { "raw": "{{base_url}}/api/v1/suppliers/top?top=3", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "suppliers", "top" ], "query": [ { "key": "top", "value": "3" } ] } }, "response": [ ] }, { "name": "Get a supplier", "request": { "method": "GET", "header": [ { "key": "authentication_token", "value": "{{authentication_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" } ], "url": { "raw": "{{base_url}}/api/v1/suppliers/4", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "suppliers", "4" ], "query": [ ] } }, "response": [ ] }, { "name": "Create a supplier", "request": { "method": "POST", "header": [ { "key": "authentication_token", "value": "{{authentication_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/suppliers", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "suppliers" ], "query": [ ] }, "body": { "mode": "raw", "raw": "{\n \"supplier\": {\n \"name\": \"Fabrikam Furniture\",\n \"email\": \"orders@fabrikam.example.com\",\n \"cc_emails\": \"ap@fabrikam.example.com, sales@fabrikam.example.com\",\n \"address\": \"12 Industrial Ave, Grand Rapids, MI 49503\",\n \"contact_person\": \"Ana Trujillo\",\n \"phone_number\": \"+1 555 0500\",\n \"tax_number\": \"38-2223334\",\n \"currency_id\": 2000,\n \"payment_term_id\": 3,\n \"payment_terms\": \"Net 30\",\n \"notes\": \"Office furniture and fit-out\",\n \"external_vendor_id\": \"VEND-1001\",\n \"department_ids\": [\n 2,\n 4\n ],\n \"uei\": \"FABRK1234567\",\n \"cage_code\": \"1ABC2\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ ] }, { "name": "Update a supplier", "request": { "method": "PUT", "header": [ { "key": "authentication_token", "value": "{{authentication_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/suppliers/4", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "suppliers", "4" ], "query": [ ] }, "body": { "mode": "raw", "raw": "{\n \"supplier\": {\n \"contact_person\": \"Ana Trujillo-Reyes\",\n \"phone_number\": \"+1 555 0501\",\n \"payment_term_id\": 4,\n \"payment_terms\": \"Net 60\",\n \"department_ids\": [\n 2\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ ] } ] }, { "name": "Suppliers: Approvals", "item": [ { "name": "List supplier approval requests", "request": { "method": "GET", "header": [ { "key": "authentication_token", "value": "{{authentication_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" } ], "url": { "raw": "{{base_url}}/api/v1/supplier_approvals", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "supplier_approvals" ], "query": [ ] } }, "response": [ ] } ] }, { "name": "Tax Rates", "item": [ { "name": "List tax rates", "request": { "method": "GET", "header": [ { "key": "authentication_token", "value": "{{authentication_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" } ], "url": { "raw": "{{base_url}}/api/v1/tax_rates", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "tax_rates" ], "query": [ ] } }, "response": [ ] }, { "name": "Get a tax rate", "request": { "method": "GET", "header": [ { "key": "authentication_token", "value": "{{authentication_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" } ], "url": { "raw": "{{base_url}}/api/v1/tax_rates/4", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "tax_rates", "4" ], "query": [ ] } }, "response": [ ] }, { "name": "Create a tax rate", "request": { "method": "POST", "header": [ { "key": "authentication_token", "value": "{{authentication_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/tax_rates", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "tax_rates" ], "query": [ ] }, "body": { "mode": "raw", "raw": "{\n \"tax_rate\": {\n \"name\": \"State Tax\",\n \"value\": 6.25\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ ] }, { "name": "Update a tax rate", "request": { "method": "PUT", "header": [ { "key": "authentication_token", "value": "{{authentication_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/tax_rates/26", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "tax_rates", "26" ], "query": [ ] }, "body": { "mode": "raw", "raw": "{\n \"tax_rate\": {\n \"name\": \"State Tax 6.5%\",\n \"value\": 6.5\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ ] } ] }, { "name": "Users", "item": [ { "name": "Get the current user", "request": { "method": "GET", "header": [ { "key": "authentication_token", "value": "{{authentication_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" } ], "url": { "raw": "{{base_url}}/api/v1/currentuser", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "currentuser" ], "query": [ ] } }, "response": [ ] }, { "name": "Update the current user", "request": { "method": "PUT", "header": [ { "key": "authentication_token", "value": "{{authentication_token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/currentuser", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "currentuser" ], "query": [ ] }, "body": { "mode": "raw", "raw": "{\n \"first_name\": \"Leland\",\n \"last_name\": \"Login\",\n \"phone_number\": \"+1 555 0101\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ ] }, { "name": "Update the current user (by id)", "request": { "method": "PUT", "header": [ { "key": "authentication_token", "value": "{{authentication_token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/users/4", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "users", "4" ], "query": [ ] }, "body": { "mode": "raw", "raw": "{\n \"phone_number\": \"+1 555 0103\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ ] } ] }, { "name": "Webhooks", "item": [ { "name": "List webhook subscriptions", "request": { "method": "GET", "header": [ { "key": "authentication_token", "value": "{{authentication_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" } ], "url": { "raw": "{{base_url}}/api/v1/webhooks", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "webhooks" ], "query": [ ] } }, "response": [ ] }, { "name": "Retrieve a webhook subscription", "request": { "method": "GET", "header": [ { "key": "authentication_token", "value": "{{authentication_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" } ], "url": { "raw": "{{base_url}}/api/v1/webhooks/3", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "webhooks", "3" ], "query": [ ] } }, "response": [ ] }, { "name": "Create a webhook subscription", "request": { "method": "POST", "header": [ { "key": "authentication_token", "value": "{{authentication_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/webhooks", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "webhooks" ], "query": [ ] }, "body": { "mode": "raw", "raw": "{\n \"webhook\": {\n \"name\": \"ERP purchase order feed (v1, webhooks_internal)\",\n \"url\": \"https://erp.acme.test/pex/webhooks\",\n \"event_type\": [\n \"new_po\",\n \"po_approved\",\n \"po_delivered\",\n \"po_paid\",\n \"po_cancelled\",\n \"po_update\"\n ],\n \"json_wrapper\": \"data\",\n \"send_as_text\": false,\n \"basic_auth_uname\": \"pex-sync\",\n \"basic_auth_pword\": \"s3cr3t-basic-pass\",\n \"webhook_attributes_attributes\": [\n {\n \"attrib_type\": \"header\",\n \"key\": \"X-Source-System\",\n \"value\": \"procurementexpress\"\n },\n {\n \"attrib_type\": \"root\",\n \"key\": \"tenant\",\n \"value\": \"acme-corp\"\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ ] }, { "name": "Update or archive a webhook subscription", "request": { "method": "PUT", "header": [ { "key": "authentication_token", "value": "{{authentication_token}}" }, { "key": "app_company_id", "value": "{{company_id}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/webhooks/2", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "webhooks", "2" ], "query": [ ] }, "body": { "mode": "raw", "raw": "{\n \"webhook\": {\n \"name\": \"ERP purchase order feed (v1, webhooks_internal) - approvals only\",\n \"event_type\": [\n \"po_approved\",\n \"po_cancelled\"\n ],\n \"basic_auth_pword\": \"\",\n \"webhook_attributes_attributes\": [\n {\n \"id\": 1,\n \"attrib_type\": \"header\",\n \"key\": \"X-Source-System\",\n \"value\": \"pex-production\"\n },\n {\n \"attrib_type\": \"root\",\n \"key\": \"tenant\",\n \"value\": \"acme-corp\"\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ ] } ] } ] } ] }