{ "item": [ { "id": "c0bd2076-3f78-43b4-b2b4-22fd7453aed8", "name": "Attachments", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "c25fc524-3e66-4458-8abd-0864727e0694", "name": "Download attachment", "request": { "name": "Download attachment", "description": { "content": "\nDownload an attachment file from S3 storage by its `attachment_token`.\n\n**Access control:** authenticated API user. The user is already\ncustomer-scoped — there is no cross-customer reachability because each\ncustomer has its own database.\n\n**Disposition:**\n- Default: `Content-Disposition: attachment` (downloads with original filename).\n- Pass `?inline=true` to render in-browser instead.\n\n**Token source:** the `attachment_token` is returned in the invoice\ndetail response at `invoice.attachments[].attachment_token`.\n ", "type": "text/plain" }, "url": { "path": [ "v1", "attachment", ":attachment_token" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "key": "inline", "value": "false", "description": "Render inline in browser (true) or force download (false)" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "attachment_token", "description": "(Required) Attachment token (UUID) from invoice.attachments[].attachment_token" } ] }, "header": [ { "key": "Accept", "value": "application/pdf" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "6e8d4a0c-8f88-4ffc-b609-699d0f24d869", "name": "File retrieved", "originalRequest": { "url": { "path": [ "v1", "attachment", ":attachment_token" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "inline", "value": "false" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "attachment_token", "description": "(Required) Attachment token (UUID) from invoice.attachments[].attachment_token" } ] }, "header": [ { "key": "Accept", "value": "application/pdf" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "disabled": false, "description": "attachment | inline", "key": "Content-Disposition", "value": "string" }, { "key": "Content-Type", "value": "application/pdf" } ], "body": "string", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "96836ccb-ab84-462f-8883-9feb70bd3939", "name": "Invalid or missing attachment_token", "originalRequest": { "url": { "path": [ "v1", "attachment", ":attachment_token" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "inline", "value": "false" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "attachment_token", "description": "(Required) Attachment token (UUID) from invoice.attachments[].attachment_token" } ] }, "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "6f5ab10e-40f2-4ff7-8144-27856e441fd3", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1", "attachment", ":attachment_token" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "inline", "value": "false" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "attachment_token", "description": "(Required) Attachment token (UUID) from invoice.attachments[].attachment_token" } ] }, "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "278ce27d-2cb8-4b8d-b310-fdae2e4c6635", "name": "Attachment not found", "originalRequest": { "url": { "path": [ "v1", "attachment", ":attachment_token" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "inline", "value": "false" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "attachment_token", "description": "(Required) Attachment token (UUID) from invoice.attachments[].attachment_token" } ] }, "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "f5a079be-13d8-42bc-ac59-f5a2766ec378", "name": "S3 or database error", "originalRequest": { "url": { "path": [ "v1", "attachment", ":attachment_token" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "inline", "value": "false" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "attachment_token", "description": "(Required) Attachment token (UUID) from invoice.attachments[].attachment_token" } ] }, "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "318c0320-eb20-4fbe-b411-e5956bc6f71f", "name": "Stream attachment", "request": { "name": "Stream attachment", "description": { "content": "\nStream an attachment file from S3 directly to the response. Suitable\nfor embedding in iframes, browser PDF viewers, or any case where you\nwant incremental delivery instead of a buffered download.\n\n**Access control:** identical to `/attachment/{attachment_token}`.\n ", "type": "text/plain" }, "url": { "path": [ "v1", "attachment", ":attachment_token", "stream" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "attachment_token", "description": "(Required) Attachment token (UUID) from invoice.attachments[].attachment_token" } ] }, "header": [ { "key": "Accept", "value": "application/pdf" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "ddce5dd2-af7a-4fcb-8343-781331aa4d54", "name": "File streamed (inline)", "originalRequest": { "url": { "path": [ "v1", "attachment", ":attachment_token", "stream" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "attachment_token", "description": "(Required) Attachment token (UUID) from invoice.attachments[].attachment_token" } ] }, "header": [ { "key": "Accept", "value": "application/pdf" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "disabled": false, "description": "Always inline", "key": "Content-Disposition", "value": "string" }, { "key": "Content-Type", "value": "application/pdf" } ], "body": "string", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "cfb1f62d-3d4c-45b9-a1ea-98c1cae59f22", "name": "Invalid or missing attachment_token", "originalRequest": { "url": { "path": [ "v1", "attachment", ":attachment_token", "stream" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "attachment_token", "description": "(Required) Attachment token (UUID) from invoice.attachments[].attachment_token" } ] }, "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "01701274-99ef-4c5d-b104-c3f481dc7f1b", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1", "attachment", ":attachment_token", "stream" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "attachment_token", "description": "(Required) Attachment token (UUID) from invoice.attachments[].attachment_token" } ] }, "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "6923d885-d558-40a1-8958-3db730113abd", "name": "Attachment not found", "originalRequest": { "url": { "path": [ "v1", "attachment", ":attachment_token", "stream" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "attachment_token", "description": "(Required) Attachment token (UUID) from invoice.attachments[].attachment_token" } ] }, "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b8eda01d-0679-4fd4-bd47-25370b1e7e01", "name": "S3 or database error", "originalRequest": { "url": { "path": [ "v1", "attachment", ":attachment_token", "stream" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "attachment_token", "description": "(Required) Attachment token (UUID) from invoice.attachments[].attachment_token" } ] }, "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "b1b93cfd-61e4-4ab5-9eb6-de33961dbf1b", "name": "Customer Data Table", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "913c1d1c-5db4-4666-8002-524fb993ce48", "name": "List records", "request": { "name": "List records", "description": { "content": "\nRetrieve records from one of 20 available customer data tables (customer_data_table_1 through customer_data_table_20).\n\n**Customer Data Tables** are flexible storage structures for custom business data that doesn't fit standard invoice/PO models.\n\n**Field Structure**:\n- **text_field_1 to text_field_30**: Text/string data (VARCHAR 500)\n- **number_field_1 to number_field_10**: Numeric data (DECIMAL)\n- **date_field_1 to date_field_10**: Date/timestamp data\n\n**Common Use Cases**:\n- Custom product catalogs with extended attributes\n- Project tracking data with custom fields\n- Customer-specific reference data\n- Integration staging tables for external systems\n- Temporary data storage for custom workflows\n\n**Example**: A product catalog might use text_field_1 for SKU, text_field_2 for description, number_field_1 for standard price, and date_field_1 for last_updated.\n ", "type": "text/plain" }, "url": { "path": [ "v1", "customerdatatable", ":tableName" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "key": "page", "value": "1", "description": "Page number for pagination" }, { "disabled": true, "key": "limit", "value": "1000", "description": "Max records per page (up to 1000)" }, { "disabled": true, "key": "source_record_id", "value": "", "description": "Filter by source_record_id (ILIKE)" }, { "disabled": true, "key": "source_system", "value": "", "description": "Filter by source_system (ILIKE)" }, { "disabled": true, "key": "updated_before_date", "value": "", "description": "Filter by records updated before this date" }, { "disabled": true, "key": "updated_after_date", "value": "", "description": "Filter by records updated after this date" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "tableName", "description": "(Required) Table name: customer_data_table_1 to customer_data_table_20" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "131c291b-5982-4a60-8559-3cb25e1c1884", "name": "List of records", "originalRequest": { "url": { "path": [ "v1", "customerdatatable", ":tableName" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "limit", "value": "1000" }, { "key": "source_record_id", "value": "" }, { "key": "source_system", "value": "" }, { "key": "updated_before_date", "value": "" }, { "key": "updated_after_date", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "tableName", "description": "(Required) Table name: customer_data_table_1 to customer_data_table_20" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"count\": 7087,\n \"page\": 6403,\n \"totalPages\": 3034,\n \"records\": [\n {\n \"source_system\": \"string\",\n \"source_record_id\": \"string\",\n \"is_active\": true,\n \"is_deleted\": false,\n \"text_field_1\": \"string\",\n \"text_field_2\": \"string\",\n \"text_field_3\": \"string\",\n \"text_field_4\": \"string\",\n \"text_field_5\": \"string\",\n \"text_field_6\": \"string\",\n \"text_field_7\": \"string\",\n \"text_field_8\": \"string\",\n \"text_field_9\": \"string\",\n \"text_field_10\": \"string\",\n \"text_field_11\": \"string\",\n \"text_field_12\": \"string\",\n \"text_field_13\": \"string\",\n \"text_field_14\": \"string\",\n \"text_field_15\": \"string\",\n \"text_field_16\": \"string\",\n \"text_field_17\": \"string\",\n \"text_field_18\": \"string\",\n \"text_field_19\": \"string\",\n \"text_field_20\": \"string\",\n \"text_field_21\": \"string\",\n \"text_field_22\": \"string\",\n \"text_field_23\": \"string\",\n \"text_field_24\": \"string\",\n \"text_field_25\": \"string\",\n \"text_field_26\": \"string\",\n \"text_field_27\": \"string\",\n \"text_field_28\": \"string\",\n \"text_field_29\": \"string\",\n \"text_field_30\": \"string\",\n \"number_field_1\": 5850.86753213512,\n \"number_field_2\": 8085.283233749678,\n \"number_field_3\": 951.3703622273972,\n \"number_field_4\": 9666.920828343827,\n \"number_field_5\": 2942.445754762415,\n \"number_field_6\": 8160.3493940722265,\n \"number_field_7\": 3387.2148527365,\n \"number_field_8\": 2162.648452308367,\n \"number_field_9\": 5334.402327245566,\n \"number_field_10\": 2153.5208849468954,\n \"date_field_1\": \"1972-03-28T00:55:16.508Z\",\n \"date_field_2\": \"1969-09-18T00:51:51.013Z\",\n \"date_field_3\": \"2017-11-03T08:43:32.183Z\",\n \"date_field_4\": \"1948-09-23T14:18:43.138Z\",\n \"date_field_5\": \"2000-12-09T19:31:56.932Z\",\n \"date_field_6\": \"1955-01-27T18:50:56.915Z\",\n \"date_field_7\": \"1992-07-17T14:21:35.976Z\",\n \"date_field_8\": \"2011-05-15T17:09:29.978Z\",\n \"date_field_9\": \"2004-03-17T06:06:23.540Z\",\n \"date_field_10\": \"2011-07-15T13:10:08.303Z\"\n },\n {\n \"source_system\": \"string\",\n \"source_record_id\": \"string\",\n \"is_active\": true,\n \"is_deleted\": true,\n \"text_field_1\": \"string\",\n \"text_field_2\": \"string\",\n \"text_field_3\": \"string\",\n \"text_field_4\": \"string\",\n \"text_field_5\": \"string\",\n \"text_field_6\": \"string\",\n \"text_field_7\": \"string\",\n \"text_field_8\": \"string\",\n \"text_field_9\": \"string\",\n \"text_field_10\": \"string\",\n \"text_field_11\": \"string\",\n \"text_field_12\": \"string\",\n \"text_field_13\": \"string\",\n \"text_field_14\": \"string\",\n \"text_field_15\": \"string\",\n \"text_field_16\": \"string\",\n \"text_field_17\": \"string\",\n \"text_field_18\": \"string\",\n \"text_field_19\": \"string\",\n \"text_field_20\": \"string\",\n \"text_field_21\": \"string\",\n \"text_field_22\": \"string\",\n \"text_field_23\": \"string\",\n \"text_field_24\": \"string\",\n \"text_field_25\": \"string\",\n \"text_field_26\": \"string\",\n \"text_field_27\": \"string\",\n \"text_field_28\": \"string\",\n \"text_field_29\": \"string\",\n \"text_field_30\": \"string\",\n \"number_field_1\": 3939.570963849057,\n \"number_field_2\": 6014.669421107457,\n \"number_field_3\": 3949.989221874026,\n \"number_field_4\": 3443.8055230462196,\n \"number_field_5\": 544.1610085189508,\n \"number_field_6\": 4940.344682655711,\n \"number_field_7\": 6230.0387838428815,\n \"number_field_8\": 3677.204601644055,\n \"number_field_9\": 3581.612594435546,\n \"number_field_10\": 8614.193369649836,\n \"date_field_1\": \"1964-07-17T19:29:41.288Z\",\n \"date_field_2\": \"1958-05-07T02:01:30.218Z\",\n \"date_field_3\": \"1992-02-02T06:54:41.783Z\",\n \"date_field_4\": \"1965-12-02T23:47:33.510Z\",\n \"date_field_5\": \"1981-03-01T03:07:44.523Z\",\n \"date_field_6\": \"2024-10-12T11:53:40.110Z\",\n \"date_field_7\": \"2021-09-02T07:09:19.874Z\",\n \"date_field_8\": \"1953-04-06T07:52:59.524Z\",\n \"date_field_9\": \"1962-06-17T22:27:45.690Z\",\n \"date_field_10\": \"1947-05-23T21:34:33.563Z\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5dec10a2-e513-44c3-a433-09016396d04c", "name": "Unauthorized - invalid or missing API key", "originalRequest": { "url": { "path": [ "v1", "customerdatatable", ":tableName" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "limit", "value": "1000" }, { "key": "source_record_id", "value": "" }, { "key": "source_system", "value": "" }, { "key": "updated_before_date", "value": "" }, { "key": "updated_after_date", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "tableName", "description": "(Required) Table name: customer_data_table_1 to customer_data_table_20" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"Unauthorized\",\n \"message\": \"API key is required\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3eb99c5d-ceff-44c6-9d6c-a473723abd2e", "name": "Forbidden - insufficient permissions", "originalRequest": { "url": { "path": [ "v1", "customerdatatable", ":tableName" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "limit", "value": "1000" }, { "key": "source_record_id", "value": "" }, { "key": "source_system", "value": "" }, { "key": "updated_before_date", "value": "" }, { "key": "updated_after_date", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "tableName", "description": "(Required) Table name: customer_data_table_1 to customer_data_table_20" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"Forbidden\",\n \"message\": \"API user does not have required permissions: READ_CDT, READ_DATA\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5e66526e-d026-4548-8fad-9d5b866c743e", "name": "Internal server error", "originalRequest": { "url": { "path": [ "v1", "customerdatatable", ":tableName" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "limit", "value": "1000" }, { "key": "source_record_id", "value": "" }, { "key": "source_system", "value": "" }, { "key": "updated_before_date", "value": "" }, { "key": "updated_after_date", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "tableName", "description": "(Required) Table name: customer_data_table_1 to customer_data_table_20" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"Internal server error\",\n \"message\": \"Database query failed\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e5c593f1-bbe5-41c3-b098-aef574e7ae6d", "name": "Upsert records", "request": { "name": "Upsert records", "description": { "content": "\nInsert or update records in one of 20 available customer data tables. Supports flexible field mapping for custom business data.\n\n**Upsert Key**: source_record_id + source_system\n\n**full_load Behavior**:\n- **false** (default): Incremental upsert - updates existing records, inserts new ones\n- **true**: Full replacement - deletes all existing records in the table, then inserts new data\n\n**Table Selection**: Use tableName path parameter to specify which table (customer_data_table_1 to customer_data_table_20)\n\n**Required Fields**: none enforced at the API layer. `source_record_id` and `source_system` are strongly recommended — together they form the natural upsert key; omitting them means every POST inserts a new row instead of updating.\n\n**Field Mapping**: Populate text_field_1-30, number_field_1-10, and date_field_1-10 based on your data model\n ", "type": "text/plain" }, "url": { "path": [ "v1", "customerdatatable", ":tableName" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "key": "full_load", "value": "false", "description": "If true, clears the table before inserting new data" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "tableName", "description": "(Required) Target table: customer_data_table_1 to customer_data_table_20" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "[\n {\n \"source_system\": \"\",\n \"source_record_id\": \"\",\n \"is_active\": \"\",\n \"is_deleted\": \"\",\n \"text_field_1\": \"\",\n \"text_field_2\": \"\",\n \"text_field_3\": \"\",\n \"text_field_4\": \"\",\n \"text_field_5\": \"\",\n \"text_field_6\": \"\",\n \"text_field_7\": \"\",\n \"text_field_8\": \"\",\n \"text_field_9\": \"\",\n \"text_field_10\": \"\",\n \"text_field_11\": \"\",\n \"text_field_12\": \"\",\n \"text_field_13\": \"\",\n \"text_field_14\": \"\",\n \"text_field_15\": \"\",\n \"text_field_16\": \"\",\n \"text_field_17\": \"\",\n \"text_field_18\": \"\",\n \"text_field_19\": \"\",\n \"text_field_20\": \"\",\n \"text_field_21\": \"\",\n \"text_field_22\": \"\",\n \"text_field_23\": \"\",\n \"text_field_24\": \"\",\n \"text_field_25\": \"\",\n \"text_field_26\": \"\",\n \"text_field_27\": \"\",\n \"text_field_28\": \"\",\n \"text_field_29\": \"\",\n \"text_field_30\": \"\",\n \"number_field_1\": \"\",\n \"number_field_2\": \"\",\n \"number_field_3\": \"\",\n \"number_field_4\": \"\",\n \"number_field_5\": \"\",\n \"number_field_6\": \"\",\n \"number_field_7\": \"\",\n \"number_field_8\": \"\",\n \"number_field_9\": \"\",\n \"number_field_10\": \"\",\n \"date_field_1\": \"\",\n \"date_field_2\": \"\",\n \"date_field_3\": \"\",\n \"date_field_4\": \"\",\n \"date_field_5\": \"\",\n \"date_field_6\": \"\",\n \"date_field_7\": \"\",\n \"date_field_8\": \"\",\n \"date_field_9\": \"\",\n \"date_field_10\": \"\"\n },\n {\n \"source_system\": \"\",\n \"source_record_id\": \"\",\n \"is_active\": \"\",\n \"is_deleted\": \"\",\n \"text_field_1\": \"\",\n \"text_field_2\": \"\",\n \"text_field_3\": \"\",\n \"text_field_4\": \"\",\n \"text_field_5\": \"\",\n \"text_field_6\": \"\",\n \"text_field_7\": \"\",\n \"text_field_8\": \"\",\n \"text_field_9\": \"\",\n \"text_field_10\": \"\",\n \"text_field_11\": \"\",\n \"text_field_12\": \"\",\n \"text_field_13\": \"\",\n \"text_field_14\": \"\",\n \"text_field_15\": \"\",\n \"text_field_16\": \"\",\n \"text_field_17\": \"\",\n \"text_field_18\": \"\",\n \"text_field_19\": \"\",\n \"text_field_20\": \"\",\n \"text_field_21\": \"\",\n \"text_field_22\": \"\",\n \"text_field_23\": \"\",\n \"text_field_24\": \"\",\n \"text_field_25\": \"\",\n \"text_field_26\": \"\",\n \"text_field_27\": \"\",\n \"text_field_28\": \"\",\n \"text_field_29\": \"\",\n \"text_field_30\": \"\",\n \"number_field_1\": \"\",\n \"number_field_2\": \"\",\n \"number_field_3\": \"\",\n \"number_field_4\": \"\",\n \"number_field_5\": \"\",\n \"number_field_6\": \"\",\n \"number_field_7\": \"\",\n \"number_field_8\": \"\",\n \"number_field_9\": \"\",\n \"number_field_10\": \"\",\n \"date_field_1\": \"\",\n \"date_field_2\": \"\",\n \"date_field_3\": \"\",\n \"date_field_4\": \"\",\n \"date_field_5\": \"\",\n \"date_field_6\": \"\",\n \"date_field_7\": \"\",\n \"date_field_8\": \"\",\n \"date_field_9\": \"\",\n \"date_field_10\": \"\"\n }\n]", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "72452ff1-d1f1-4293-b8da-e019ed937b75", "name": "Insert/update result", "originalRequest": { "url": { "path": [ "v1", "customerdatatable", ":tableName" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "full_load", "value": "false" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "tableName", "description": "(Required) Target table: customer_data_table_1 to customer_data_table_20" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "[\n {\n \"source_system\": \"\",\n \"source_record_id\": \"\",\n \"is_active\": \"\",\n \"is_deleted\": \"\",\n \"text_field_1\": \"\",\n \"text_field_2\": \"\",\n \"text_field_3\": \"\",\n \"text_field_4\": \"\",\n \"text_field_5\": \"\",\n \"text_field_6\": \"\",\n \"text_field_7\": \"\",\n \"text_field_8\": \"\",\n \"text_field_9\": \"\",\n \"text_field_10\": \"\",\n \"text_field_11\": \"\",\n \"text_field_12\": \"\",\n \"text_field_13\": \"\",\n \"text_field_14\": \"\",\n \"text_field_15\": \"\",\n \"text_field_16\": \"\",\n \"text_field_17\": \"\",\n \"text_field_18\": \"\",\n \"text_field_19\": \"\",\n \"text_field_20\": \"\",\n \"text_field_21\": \"\",\n \"text_field_22\": \"\",\n \"text_field_23\": \"\",\n \"text_field_24\": \"\",\n \"text_field_25\": \"\",\n \"text_field_26\": \"\",\n \"text_field_27\": \"\",\n \"text_field_28\": \"\",\n \"text_field_29\": \"\",\n \"text_field_30\": \"\",\n \"number_field_1\": \"\",\n \"number_field_2\": \"\",\n \"number_field_3\": \"\",\n \"number_field_4\": \"\",\n \"number_field_5\": \"\",\n \"number_field_6\": \"\",\n \"number_field_7\": \"\",\n \"number_field_8\": \"\",\n \"number_field_9\": \"\",\n \"number_field_10\": \"\",\n \"date_field_1\": \"\",\n \"date_field_2\": \"\",\n \"date_field_3\": \"\",\n \"date_field_4\": \"\",\n \"date_field_5\": \"\",\n \"date_field_6\": \"\",\n \"date_field_7\": \"\",\n \"date_field_8\": \"\",\n \"date_field_9\": \"\",\n \"date_field_10\": \"\"\n },\n {\n \"source_system\": \"\",\n \"source_record_id\": \"\",\n \"is_active\": \"\",\n \"is_deleted\": \"\",\n \"text_field_1\": \"\",\n \"text_field_2\": \"\",\n \"text_field_3\": \"\",\n \"text_field_4\": \"\",\n \"text_field_5\": \"\",\n \"text_field_6\": \"\",\n \"text_field_7\": \"\",\n \"text_field_8\": \"\",\n \"text_field_9\": \"\",\n \"text_field_10\": \"\",\n \"text_field_11\": \"\",\n \"text_field_12\": \"\",\n \"text_field_13\": \"\",\n \"text_field_14\": \"\",\n \"text_field_15\": \"\",\n \"text_field_16\": \"\",\n \"text_field_17\": \"\",\n \"text_field_18\": \"\",\n \"text_field_19\": \"\",\n \"text_field_20\": \"\",\n \"text_field_21\": \"\",\n \"text_field_22\": \"\",\n \"text_field_23\": \"\",\n \"text_field_24\": \"\",\n \"text_field_25\": \"\",\n \"text_field_26\": \"\",\n \"text_field_27\": \"\",\n \"text_field_28\": \"\",\n \"text_field_29\": \"\",\n \"text_field_30\": \"\",\n \"number_field_1\": \"\",\n \"number_field_2\": \"\",\n \"number_field_3\": \"\",\n \"number_field_4\": \"\",\n \"number_field_5\": \"\",\n \"number_field_6\": \"\",\n \"number_field_7\": \"\",\n \"number_field_8\": \"\",\n \"number_field_9\": \"\",\n \"number_field_10\": \"\",\n \"date_field_1\": \"\",\n \"date_field_2\": \"\",\n \"date_field_3\": \"\",\n \"date_field_4\": \"\",\n \"date_field_5\": \"\",\n \"date_field_6\": \"\",\n \"date_field_7\": \"\",\n \"date_field_8\": \"\",\n \"date_field_9\": \"\",\n \"date_field_10\": \"\"\n }\n]", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Records inserted/updated successfully\",\n \"recordsInserted\": 150\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a9c791b2-4fee-40fa-a867-1a57d42fb58b", "name": "Bad request - validation error", "originalRequest": { "url": { "path": [ "v1", "customerdatatable", ":tableName" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "full_load", "value": "false" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "tableName", "description": "(Required) Target table: customer_data_table_1 to customer_data_table_20" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "[\n {\n \"source_system\": \"\",\n \"source_record_id\": \"\",\n \"is_active\": \"\",\n \"is_deleted\": \"\",\n \"text_field_1\": \"\",\n \"text_field_2\": \"\",\n \"text_field_3\": \"\",\n \"text_field_4\": \"\",\n \"text_field_5\": \"\",\n \"text_field_6\": \"\",\n \"text_field_7\": \"\",\n \"text_field_8\": \"\",\n \"text_field_9\": \"\",\n \"text_field_10\": \"\",\n \"text_field_11\": \"\",\n \"text_field_12\": \"\",\n \"text_field_13\": \"\",\n \"text_field_14\": \"\",\n \"text_field_15\": \"\",\n \"text_field_16\": \"\",\n \"text_field_17\": \"\",\n \"text_field_18\": \"\",\n \"text_field_19\": \"\",\n \"text_field_20\": \"\",\n \"text_field_21\": \"\",\n \"text_field_22\": \"\",\n \"text_field_23\": \"\",\n \"text_field_24\": \"\",\n \"text_field_25\": \"\",\n \"text_field_26\": \"\",\n \"text_field_27\": \"\",\n \"text_field_28\": \"\",\n \"text_field_29\": \"\",\n \"text_field_30\": \"\",\n \"number_field_1\": \"\",\n \"number_field_2\": \"\",\n \"number_field_3\": \"\",\n \"number_field_4\": \"\",\n \"number_field_5\": \"\",\n \"number_field_6\": \"\",\n \"number_field_7\": \"\",\n \"number_field_8\": \"\",\n \"number_field_9\": \"\",\n \"number_field_10\": \"\",\n \"date_field_1\": \"\",\n \"date_field_2\": \"\",\n \"date_field_3\": \"\",\n \"date_field_4\": \"\",\n \"date_field_5\": \"\",\n \"date_field_6\": \"\",\n \"date_field_7\": \"\",\n \"date_field_8\": \"\",\n \"date_field_9\": \"\",\n \"date_field_10\": \"\"\n },\n {\n \"source_system\": \"\",\n \"source_record_id\": \"\",\n \"is_active\": \"\",\n \"is_deleted\": \"\",\n \"text_field_1\": \"\",\n \"text_field_2\": \"\",\n \"text_field_3\": \"\",\n \"text_field_4\": \"\",\n \"text_field_5\": \"\",\n \"text_field_6\": \"\",\n \"text_field_7\": \"\",\n \"text_field_8\": \"\",\n \"text_field_9\": \"\",\n \"text_field_10\": \"\",\n \"text_field_11\": \"\",\n \"text_field_12\": \"\",\n \"text_field_13\": \"\",\n \"text_field_14\": \"\",\n \"text_field_15\": \"\",\n \"text_field_16\": \"\",\n \"text_field_17\": \"\",\n \"text_field_18\": \"\",\n \"text_field_19\": \"\",\n \"text_field_20\": \"\",\n \"text_field_21\": \"\",\n \"text_field_22\": \"\",\n \"text_field_23\": \"\",\n \"text_field_24\": \"\",\n \"text_field_25\": \"\",\n \"text_field_26\": \"\",\n \"text_field_27\": \"\",\n \"text_field_28\": \"\",\n \"text_field_29\": \"\",\n \"text_field_30\": \"\",\n \"number_field_1\": \"\",\n \"number_field_2\": \"\",\n \"number_field_3\": \"\",\n \"number_field_4\": \"\",\n \"number_field_5\": \"\",\n \"number_field_6\": \"\",\n \"number_field_7\": \"\",\n \"number_field_8\": \"\",\n \"number_field_9\": \"\",\n \"number_field_10\": \"\",\n \"date_field_1\": \"\",\n \"date_field_2\": \"\",\n \"date_field_3\": \"\",\n \"date_field_4\": \"\",\n \"date_field_5\": \"\",\n \"date_field_6\": \"\",\n \"date_field_7\": \"\",\n \"date_field_8\": \"\",\n \"date_field_9\": \"\",\n \"date_field_10\": \"\"\n }\n]", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"Validation error\",\n \"message\": \"Record 0: Missing required field: source_record_id\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "38c8808f-a008-4609-8c93-964027c5fb3c", "name": "Unauthorized - invalid or missing API key", "originalRequest": { "url": { "path": [ "v1", "customerdatatable", ":tableName" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "full_load", "value": "false" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "tableName", "description": "(Required) Target table: customer_data_table_1 to customer_data_table_20" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "[\n {\n \"source_system\": \"\",\n \"source_record_id\": \"\",\n \"is_active\": \"\",\n \"is_deleted\": \"\",\n \"text_field_1\": \"\",\n \"text_field_2\": \"\",\n \"text_field_3\": \"\",\n \"text_field_4\": \"\",\n \"text_field_5\": \"\",\n \"text_field_6\": \"\",\n \"text_field_7\": \"\",\n \"text_field_8\": \"\",\n \"text_field_9\": \"\",\n \"text_field_10\": \"\",\n \"text_field_11\": \"\",\n \"text_field_12\": \"\",\n \"text_field_13\": \"\",\n \"text_field_14\": \"\",\n \"text_field_15\": \"\",\n \"text_field_16\": \"\",\n \"text_field_17\": \"\",\n \"text_field_18\": \"\",\n \"text_field_19\": \"\",\n \"text_field_20\": \"\",\n \"text_field_21\": \"\",\n \"text_field_22\": \"\",\n \"text_field_23\": \"\",\n \"text_field_24\": \"\",\n \"text_field_25\": \"\",\n \"text_field_26\": \"\",\n \"text_field_27\": \"\",\n \"text_field_28\": \"\",\n \"text_field_29\": \"\",\n \"text_field_30\": \"\",\n \"number_field_1\": \"\",\n \"number_field_2\": \"\",\n \"number_field_3\": \"\",\n \"number_field_4\": \"\",\n \"number_field_5\": \"\",\n \"number_field_6\": \"\",\n \"number_field_7\": \"\",\n \"number_field_8\": \"\",\n \"number_field_9\": \"\",\n \"number_field_10\": \"\",\n \"date_field_1\": \"\",\n \"date_field_2\": \"\",\n \"date_field_3\": \"\",\n \"date_field_4\": \"\",\n \"date_field_5\": \"\",\n \"date_field_6\": \"\",\n \"date_field_7\": \"\",\n \"date_field_8\": \"\",\n \"date_field_9\": \"\",\n \"date_field_10\": \"\"\n },\n {\n \"source_system\": \"\",\n \"source_record_id\": \"\",\n \"is_active\": \"\",\n \"is_deleted\": \"\",\n \"text_field_1\": \"\",\n \"text_field_2\": \"\",\n \"text_field_3\": \"\",\n \"text_field_4\": \"\",\n \"text_field_5\": \"\",\n \"text_field_6\": \"\",\n \"text_field_7\": \"\",\n \"text_field_8\": \"\",\n \"text_field_9\": \"\",\n \"text_field_10\": \"\",\n \"text_field_11\": \"\",\n \"text_field_12\": \"\",\n \"text_field_13\": \"\",\n \"text_field_14\": \"\",\n \"text_field_15\": \"\",\n \"text_field_16\": \"\",\n \"text_field_17\": \"\",\n \"text_field_18\": \"\",\n \"text_field_19\": \"\",\n \"text_field_20\": \"\",\n \"text_field_21\": \"\",\n \"text_field_22\": \"\",\n \"text_field_23\": \"\",\n \"text_field_24\": \"\",\n \"text_field_25\": \"\",\n \"text_field_26\": \"\",\n \"text_field_27\": \"\",\n \"text_field_28\": \"\",\n \"text_field_29\": \"\",\n \"text_field_30\": \"\",\n \"number_field_1\": \"\",\n \"number_field_2\": \"\",\n \"number_field_3\": \"\",\n \"number_field_4\": \"\",\n \"number_field_5\": \"\",\n \"number_field_6\": \"\",\n \"number_field_7\": \"\",\n \"number_field_8\": \"\",\n \"number_field_9\": \"\",\n \"number_field_10\": \"\",\n \"date_field_1\": \"\",\n \"date_field_2\": \"\",\n \"date_field_3\": \"\",\n \"date_field_4\": \"\",\n \"date_field_5\": \"\",\n \"date_field_6\": \"\",\n \"date_field_7\": \"\",\n \"date_field_8\": \"\",\n \"date_field_9\": \"\",\n \"date_field_10\": \"\"\n }\n]", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"Unauthorized\",\n \"message\": \"API key is required\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1abd8fae-b8aa-4c7e-bb30-be5c473d91ff", "name": "Forbidden - insufficient permissions", "originalRequest": { "url": { "path": [ "v1", "customerdatatable", ":tableName" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "full_load", "value": "false" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "tableName", "description": "(Required) Target table: customer_data_table_1 to customer_data_table_20" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "[\n {\n \"source_system\": \"\",\n \"source_record_id\": \"\",\n \"is_active\": \"\",\n \"is_deleted\": \"\",\n \"text_field_1\": \"\",\n \"text_field_2\": \"\",\n \"text_field_3\": \"\",\n \"text_field_4\": \"\",\n \"text_field_5\": \"\",\n \"text_field_6\": \"\",\n \"text_field_7\": \"\",\n \"text_field_8\": \"\",\n \"text_field_9\": \"\",\n \"text_field_10\": \"\",\n \"text_field_11\": \"\",\n \"text_field_12\": \"\",\n \"text_field_13\": \"\",\n \"text_field_14\": \"\",\n \"text_field_15\": \"\",\n \"text_field_16\": \"\",\n \"text_field_17\": \"\",\n \"text_field_18\": \"\",\n \"text_field_19\": \"\",\n \"text_field_20\": \"\",\n \"text_field_21\": \"\",\n \"text_field_22\": \"\",\n \"text_field_23\": \"\",\n \"text_field_24\": \"\",\n \"text_field_25\": \"\",\n \"text_field_26\": \"\",\n \"text_field_27\": \"\",\n \"text_field_28\": \"\",\n \"text_field_29\": \"\",\n \"text_field_30\": \"\",\n \"number_field_1\": \"\",\n \"number_field_2\": \"\",\n \"number_field_3\": \"\",\n \"number_field_4\": \"\",\n \"number_field_5\": \"\",\n \"number_field_6\": \"\",\n \"number_field_7\": \"\",\n \"number_field_8\": \"\",\n \"number_field_9\": \"\",\n \"number_field_10\": \"\",\n \"date_field_1\": \"\",\n \"date_field_2\": \"\",\n \"date_field_3\": \"\",\n \"date_field_4\": \"\",\n \"date_field_5\": \"\",\n \"date_field_6\": \"\",\n \"date_field_7\": \"\",\n \"date_field_8\": \"\",\n \"date_field_9\": \"\",\n \"date_field_10\": \"\"\n },\n {\n \"source_system\": \"\",\n \"source_record_id\": \"\",\n \"is_active\": \"\",\n \"is_deleted\": \"\",\n \"text_field_1\": \"\",\n \"text_field_2\": \"\",\n \"text_field_3\": \"\",\n \"text_field_4\": \"\",\n \"text_field_5\": \"\",\n \"text_field_6\": \"\",\n \"text_field_7\": \"\",\n \"text_field_8\": \"\",\n \"text_field_9\": \"\",\n \"text_field_10\": \"\",\n \"text_field_11\": \"\",\n \"text_field_12\": \"\",\n \"text_field_13\": \"\",\n \"text_field_14\": \"\",\n \"text_field_15\": \"\",\n \"text_field_16\": \"\",\n \"text_field_17\": \"\",\n \"text_field_18\": \"\",\n \"text_field_19\": \"\",\n \"text_field_20\": \"\",\n \"text_field_21\": \"\",\n \"text_field_22\": \"\",\n \"text_field_23\": \"\",\n \"text_field_24\": \"\",\n \"text_field_25\": \"\",\n \"text_field_26\": \"\",\n \"text_field_27\": \"\",\n \"text_field_28\": \"\",\n \"text_field_29\": \"\",\n \"text_field_30\": \"\",\n \"number_field_1\": \"\",\n \"number_field_2\": \"\",\n \"number_field_3\": \"\",\n \"number_field_4\": \"\",\n \"number_field_5\": \"\",\n \"number_field_6\": \"\",\n \"number_field_7\": \"\",\n \"number_field_8\": \"\",\n \"number_field_9\": \"\",\n \"number_field_10\": \"\",\n \"date_field_1\": \"\",\n \"date_field_2\": \"\",\n \"date_field_3\": \"\",\n \"date_field_4\": \"\",\n \"date_field_5\": \"\",\n \"date_field_6\": \"\",\n \"date_field_7\": \"\",\n \"date_field_8\": \"\",\n \"date_field_9\": \"\",\n \"date_field_10\": \"\"\n }\n]", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"Forbidden\",\n \"message\": \"API user does not have required permissions: POST_CDT, POST_DATA\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cc536dcd-5806-443e-80d5-54c6d214fa71", "name": "Internal server error", "originalRequest": { "url": { "path": [ "v1", "customerdatatable", ":tableName" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "full_load", "value": "false" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "tableName", "description": "(Required) Target table: customer_data_table_1 to customer_data_table_20" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "[\n {\n \"source_system\": \"\",\n \"source_record_id\": \"\",\n \"is_active\": \"\",\n \"is_deleted\": \"\",\n \"text_field_1\": \"\",\n \"text_field_2\": \"\",\n \"text_field_3\": \"\",\n \"text_field_4\": \"\",\n \"text_field_5\": \"\",\n \"text_field_6\": \"\",\n \"text_field_7\": \"\",\n \"text_field_8\": \"\",\n \"text_field_9\": \"\",\n \"text_field_10\": \"\",\n \"text_field_11\": \"\",\n \"text_field_12\": \"\",\n \"text_field_13\": \"\",\n \"text_field_14\": \"\",\n \"text_field_15\": \"\",\n \"text_field_16\": \"\",\n \"text_field_17\": \"\",\n \"text_field_18\": \"\",\n \"text_field_19\": \"\",\n \"text_field_20\": \"\",\n \"text_field_21\": \"\",\n \"text_field_22\": \"\",\n \"text_field_23\": \"\",\n \"text_field_24\": \"\",\n \"text_field_25\": \"\",\n \"text_field_26\": \"\",\n \"text_field_27\": \"\",\n \"text_field_28\": \"\",\n \"text_field_29\": \"\",\n \"text_field_30\": \"\",\n \"number_field_1\": \"\",\n \"number_field_2\": \"\",\n \"number_field_3\": \"\",\n \"number_field_4\": \"\",\n \"number_field_5\": \"\",\n \"number_field_6\": \"\",\n \"number_field_7\": \"\",\n \"number_field_8\": \"\",\n \"number_field_9\": \"\",\n \"number_field_10\": \"\",\n \"date_field_1\": \"\",\n \"date_field_2\": \"\",\n \"date_field_3\": \"\",\n \"date_field_4\": \"\",\n \"date_field_5\": \"\",\n \"date_field_6\": \"\",\n \"date_field_7\": \"\",\n \"date_field_8\": \"\",\n \"date_field_9\": \"\",\n \"date_field_10\": \"\"\n },\n {\n \"source_system\": \"\",\n \"source_record_id\": \"\",\n \"is_active\": \"\",\n \"is_deleted\": \"\",\n \"text_field_1\": \"\",\n \"text_field_2\": \"\",\n \"text_field_3\": \"\",\n \"text_field_4\": \"\",\n \"text_field_5\": \"\",\n \"text_field_6\": \"\",\n \"text_field_7\": \"\",\n \"text_field_8\": \"\",\n \"text_field_9\": \"\",\n \"text_field_10\": \"\",\n \"text_field_11\": \"\",\n \"text_field_12\": \"\",\n \"text_field_13\": \"\",\n \"text_field_14\": \"\",\n \"text_field_15\": \"\",\n \"text_field_16\": \"\",\n \"text_field_17\": \"\",\n \"text_field_18\": \"\",\n \"text_field_19\": \"\",\n \"text_field_20\": \"\",\n \"text_field_21\": \"\",\n \"text_field_22\": \"\",\n \"text_field_23\": \"\",\n \"text_field_24\": \"\",\n \"text_field_25\": \"\",\n \"text_field_26\": \"\",\n \"text_field_27\": \"\",\n \"text_field_28\": \"\",\n \"text_field_29\": \"\",\n \"text_field_30\": \"\",\n \"number_field_1\": \"\",\n \"number_field_2\": \"\",\n \"number_field_3\": \"\",\n \"number_field_4\": \"\",\n \"number_field_5\": \"\",\n \"number_field_6\": \"\",\n \"number_field_7\": \"\",\n \"number_field_8\": \"\",\n \"number_field_9\": \"\",\n \"number_field_10\": \"\",\n \"date_field_1\": \"\",\n \"date_field_2\": \"\",\n \"date_field_3\": \"\",\n \"date_field_4\": \"\",\n \"date_field_5\": \"\",\n \"date_field_6\": \"\",\n \"date_field_7\": \"\",\n \"date_field_8\": \"\",\n \"date_field_9\": \"\",\n \"date_field_10\": \"\"\n }\n]", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"Internal server error\",\n \"message\": \"Failed to insert records\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "fda73aa1-7277-41d6-88bc-65fc4bb3c63d", "name": "Delete records", "request": { "name": "Delete records", "description": { "content": "\nSoft delete or deactivate records in a customer data table based on filter criteria.\n\n**Actions**:\n- **delete**: Sets is_deleted = true (soft delete)\n- **deactivate**: Sets is_active = false\n\n**Filter Parameters**: Supports filtering by source_system, source_record_id, and update dates\n ", "type": "text/plain" }, "url": { "path": [ "v1", "customerdatatable", ":tableName" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "tableName", "description": "(Required) Target table: customer_data_table_1 to customer_data_table_20" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"action\": \"\",\n \"parameters\": [\n {\n \"source_system\": \"\",\n \"source_record_id\": \"\",\n \"updated_before_date\": \"\",\n \"updated_after_date\": \"\"\n },\n {\n \"source_system\": \"\",\n \"source_record_id\": \"\",\n \"updated_before_date\": \"\",\n \"updated_after_date\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "5e4ff431-f131-41bf-b66d-9320a336a516", "name": "Delete/deactivate success", "originalRequest": { "url": { "path": [ "v1", "customerdatatable", ":tableName" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "tableName", "description": "(Required) Target table: customer_data_table_1 to customer_data_table_20" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"action\": \"\",\n \"parameters\": [\n {\n \"source_system\": \"\",\n \"source_record_id\": \"\",\n \"updated_before_date\": \"\",\n \"updated_after_date\": \"\"\n },\n {\n \"source_system\": \"\",\n \"source_record_id\": \"\",\n \"updated_before_date\": \"\",\n \"updated_after_date\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Records deleted successfully\",\n \"source_record_ids\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7db90880-4b40-4265-8234-b4a08daec416", "name": "Bad request - invalid action or parameters", "originalRequest": { "url": { "path": [ "v1", "customerdatatable", ":tableName" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "tableName", "description": "(Required) Target table: customer_data_table_1 to customer_data_table_20" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"action\": \"\",\n \"parameters\": [\n {\n \"source_system\": \"\",\n \"source_record_id\": \"\",\n \"updated_before_date\": \"\",\n \"updated_after_date\": \"\"\n },\n {\n \"source_system\": \"\",\n \"source_record_id\": \"\",\n \"updated_before_date\": \"\",\n \"updated_after_date\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"Validation error\",\n \"message\": \"Action must be either \\\"delete\\\" or \\\"deactivate\\\"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dc90ab6f-a6d8-4ed5-a917-23d6b7f3018a", "name": "Unauthorized - invalid or missing API key", "originalRequest": { "url": { "path": [ "v1", "customerdatatable", ":tableName" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "tableName", "description": "(Required) Target table: customer_data_table_1 to customer_data_table_20" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"action\": \"\",\n \"parameters\": [\n {\n \"source_system\": \"\",\n \"source_record_id\": \"\",\n \"updated_before_date\": \"\",\n \"updated_after_date\": \"\"\n },\n {\n \"source_system\": \"\",\n \"source_record_id\": \"\",\n \"updated_before_date\": \"\",\n \"updated_after_date\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"Unauthorized\",\n \"message\": \"API key is required\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c8ea1c1b-1556-44a9-a9d3-23b440a4df1d", "name": "Forbidden - insufficient permissions", "originalRequest": { "url": { "path": [ "v1", "customerdatatable", ":tableName" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "tableName", "description": "(Required) Target table: customer_data_table_1 to customer_data_table_20" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"action\": \"\",\n \"parameters\": [\n {\n \"source_system\": \"\",\n \"source_record_id\": \"\",\n \"updated_before_date\": \"\",\n \"updated_after_date\": \"\"\n },\n {\n \"source_system\": \"\",\n \"source_record_id\": \"\",\n \"updated_before_date\": \"\",\n \"updated_after_date\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"Forbidden\",\n \"message\": \"API user does not have required permissions: POST_CDT, POST_DATA\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c82ba644-3908-444e-b5d2-7e8dd8e79b68", "name": "Internal server error", "originalRequest": { "url": { "path": [ "v1", "customerdatatable", ":tableName" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "tableName", "description": "(Required) Target table: customer_data_table_1 to customer_data_table_20" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"action\": \"\",\n \"parameters\": [\n {\n \"source_system\": \"\",\n \"source_record_id\": \"\",\n \"updated_before_date\": \"\",\n \"updated_after_date\": \"\"\n },\n {\n \"source_system\": \"\",\n \"source_record_id\": \"\",\n \"updated_before_date\": \"\",\n \"updated_after_date\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"Internal server error\",\n \"message\": \"Failed to delete records\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "4213ae8f-8c39-4372-ad50-e206a3f1f082", "name": "Delta State", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "fea5fc44-220e-48f5-ba8b-b4eae9f52348", "name": "Get stream state", "request": { "name": "Get stream state", "description": { "content": "\nReturns the row from `delta_stream_state` for this stream, or a synthetic\n`status: 'idle'` payload if no row exists yet — callers can treat both\ncases identically.\n\n**Use this before `begin`** if you care about concurrency. The API itself\nwill happily accept a new `begin` on top of a row that's already\n`running`; the consumer decides whether to skip, override based on age,\nor fail loudly. Typical pattern:\n\n```js\nconst s = GET /delta/streams/erp/invoices\nif (s.status === 'running') {\n const ageMin = (Date.now() - new Date(s.started_at_utc)) / 60000;\n if (ageMin < 60) return; // skip — earlier run still active\n // else fall through to begin (override stuck run)\n}\n```\n ", "type": "text/plain" }, "url": { "path": [ "v1", "delta", "streams", ":connector", ":stream" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "connector", "description": "(Required) Connector name (e.g. `coupa`)" }, { "disabled": false, "type": "any", "value": "", "key": "stream", "description": "(Required) Stream within the connector (e.g. `invoices`)" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "fee1adb2-48d2-4ed1-94c6-a947797599b8", "name": "Stream state", "originalRequest": { "url": { "path": [ "v1", "delta", "streams", ":connector", ":stream" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "connector", "description": "(Required) Connector name (e.g. `coupa`)" }, { "disabled": false, "type": "any", "value": "", "key": "stream", "description": "(Required) Stream within the connector (e.g. `invoices`)" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"connector_name\": \"string\",\n \"stream_name\": \"string\",\n \"cursor_type\": \"numeric_id\",\n \"committed_cursor_value\": \"string\",\n \"committed_at_utc\": \"1971-08-20T21:02:03.749Z\",\n \"status\": \"running\",\n \"started_at_utc\": \"1985-02-01T19:03:04.624Z\",\n \"completed_at_utc\": \"2023-02-01T20:48:20.773Z\",\n \"records_processed\": 3966,\n \"error_summary\": \"string\",\n \"metadata\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": true\n },\n \"updated_at_utc\": \"2003-03-07T06:41:30.178Z\",\n \"updated_by\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "627b8396-be48-44a3-838b-1f87f787e475", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1", "delta", "streams", ":connector", ":stream" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "connector", "description": "(Required) Connector name (e.g. `coupa`)" }, { "disabled": false, "type": "any", "value": "", "key": "stream", "description": "(Required) Stream within the connector (e.g. `invoices`)" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"string\",\n \"code\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4ef04e61-f83c-4a6d-880f-2f8b2ca9542a", "name": "Forbidden — missing DELTA_READ", "originalRequest": { "url": { "path": [ "v1", "delta", "streams", ":connector", ":stream" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "connector", "description": "(Required) Connector name (e.g. `coupa`)" }, { "disabled": false, "type": "any", "value": "", "key": "stream", "description": "(Required) Stream within the connector (e.g. `invoices`)" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"string\",\n \"code\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bc1d7843-34b9-4ef7-8341-d5d656b61eb7", "name": "Internal server error", "originalRequest": { "url": { "path": [ "v1", "delta", "streams", ":connector", ":stream" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "connector", "description": "(Required) Connector name (e.g. `coupa`)" }, { "disabled": false, "type": "any", "value": "", "key": "stream", "description": "(Required) Stream within the connector (e.g. `invoices`)" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"string\",\n \"code\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4061696c-5cc3-42ac-9813-091ba345a8f1", "name": "Begin run", "request": { "name": "Begin run", "description": { "content": "\nOverwrites the row's run-state fields in place. Returns the committed\ncursor (the lower bound the connector should fetch from) and a fresh\n`started_at_utc`.\n\n**Important**: this endpoint does NOT refuse to begin a new run while\nanother is `running`. The consumer owns concurrency policy — see the\n`getState` endpoint description for the read-then-decide pattern.\n ", "type": "text/plain" }, "url": { "path": [ "v1", "delta", "streams", ":connector", ":stream", "begin" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "connector", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "stream", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"cursor_type\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "b5460f16-804b-444a-af45-495aa5c60de3", "name": "Run started", "originalRequest": { "url": { "path": [ "v1", "delta", "streams", ":connector", ":stream", "begin" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "connector", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "stream", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"cursor_type\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"committed_cursor_value\": \"string\",\n \"cursor_type\": \"timestamp_utc\",\n \"started_at_utc\": \"1965-01-01T06:40:17.278Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "233706e6-fe9a-4ba2-9ae6-7f2e77ac4c3f", "name": "Bad request", "originalRequest": { "url": { "path": [ "v1", "delta", "streams", ":connector", ":stream", "begin" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "connector", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "stream", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"cursor_type\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"MISSING_CURSOR_TYPE\",\n \"message\": \"cursor_type is required (timestamp_utc | numeric_id | opaque_token)\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2ca5923a-2a9b-4c05-b7ea-989441aa10b8", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1", "delta", "streams", ":connector", ":stream", "begin" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "connector", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "stream", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"cursor_type\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"string\",\n \"code\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "80453c18-3ff5-4183-a39d-82e87f37841b", "name": "Forbidden — missing DELTA_WRITE", "originalRequest": { "url": { "path": [ "v1", "delta", "streams", ":connector", ":stream", "begin" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "connector", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "stream", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"cursor_type\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"string\",\n \"code\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "343a7362-89ac-47da-87c8-9fdb52df09ed", "name": "Invalid cursor_type value", "originalRequest": { "url": { "path": [ "v1", "delta", "streams", ":connector", ":stream", "begin" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "connector", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "stream", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"cursor_type\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"INVALID_CURSOR_TYPE\",\n \"message\": \"cursor_type must be one of timestamp_utc, numeric_id, opaque_token, got foo\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1e68f0d0-83f4-4f7b-9641-ea63e0b365ec", "name": "Internal server error", "originalRequest": { "url": { "path": [ "v1", "delta", "streams", ":connector", ":stream", "begin" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "connector", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "stream", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"cursor_type\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"string\",\n \"code\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4dc2456b-c7ab-4fd4-807b-7b458bc2cb95", "name": "Complete run", "request": { "name": "Complete run", "description": { "content": "\nAdvances `committed_cursor_value` to `new_cursor_value` if and only if\nthe new value is **monotonic** with respect to the cursor type:\n\n- `timestamp_utc`: must parse as a timestamp; must be `>=` previous.\n- `numeric_id`: must parse as a number; must be `>=` previous.\n- `opaque_token`: any non-equal value is treated as advance (caller's domain decides ordering).\n\nCursor regression returns 422 `CURSOR_REGRESSION` — that's a bug signal\nworth catching. To deliberately move the cursor backwards, use\n`/reset` (admin-scoped, audited).\n\nA successful complete writes a row to `delta_audit_log` with\n`event_type='cursor_advance'`.\n ", "type": "text/plain" }, "url": { "path": [ "v1", "delta", "streams", ":connector", ":stream", "complete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "connector", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "stream", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"new_cursor_value\": \"\",\n \"records_processed\": \"\",\n \"metadata\": {\n \"key_0\": 4567,\n \"key_1\": 7646\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "7c5e9d01-4a7e-429d-97dc-7fd856251f3c", "name": "Run completed, cursor advanced", "originalRequest": { "url": { "path": [ "v1", "delta", "streams", ":connector", ":stream", "complete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "connector", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "stream", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"new_cursor_value\": \"\",\n \"records_processed\": \"\",\n \"metadata\": {\n \"key_0\": false,\n \"key_1\": true\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": true,\n \"committed_cursor\": \"string\",\n \"previous_cursor\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9a92a4ca-9927-4a38-b98b-094ffb9046e0", "name": "Bad request", "originalRequest": { "url": { "path": [ "v1", "delta", "streams", ":connector", ":stream", "complete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "connector", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "stream", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"new_cursor_value\": \"\",\n \"records_processed\": \"\",\n \"metadata\": {\n \"key_0\": false,\n \"key_1\": true\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"MISSING_CURSOR\",\n \"message\": \"new_cursor_value is required for complete_run\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "03dca7ac-3964-435c-8e7a-07a4da5c572b", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1", "delta", "streams", ":connector", ":stream", "complete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "connector", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "stream", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"new_cursor_value\": \"\",\n \"records_processed\": \"\",\n \"metadata\": {\n \"key_0\": false,\n \"key_1\": true\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"string\",\n \"code\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "40b9dfa7-3de6-4c1d-bc0d-f919b397a627", "name": "Forbidden — missing DELTA_WRITE", "originalRequest": { "url": { "path": [ "v1", "delta", "streams", ":connector", ":stream", "complete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "connector", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "stream", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"new_cursor_value\": \"\",\n \"records_processed\": \"\",\n \"metadata\": {\n \"key_0\": false,\n \"key_1\": true\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"string\",\n \"code\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4f34ac5e-4353-4322-9bd2-9c3d5a130493", "name": "Stream not found — call /begin first", "originalRequest": { "url": { "path": [ "v1", "delta", "streams", ":connector", ":stream", "complete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "connector", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "stream", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"new_cursor_value\": \"\",\n \"records_processed\": \"\",\n \"metadata\": {\n \"key_0\": false,\n \"key_1\": true\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"STREAM_NOT_FOUND\",\n \"message\": \"No delta_stream_state row for coupa/invoices — call begin_run first\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "270654cb-8a65-4a6d-8459-0f086d5c24e5", "name": "Invalid or regressing cursor", "originalRequest": { "url": { "path": [ "v1", "delta", "streams", ":connector", ":stream", "complete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "connector", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "stream", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"new_cursor_value\": \"\",\n \"records_processed\": \"\",\n \"metadata\": {\n \"key_0\": false,\n \"key_1\": true\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"CURSOR_REGRESSION\",\n \"message\": \"cursor regression: new value 2026-04-01T00:00:00.000Z < committed 2026-04-15T00:00:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9980ac51-f135-44e2-adc3-e0cfa8fe8536", "name": "Internal server error", "originalRequest": { "url": { "path": [ "v1", "delta", "streams", ":connector", ":stream", "complete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "connector", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "stream", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"new_cursor_value\": \"\",\n \"records_processed\": \"\",\n \"metadata\": {\n \"key_0\": false,\n \"key_1\": true\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"string\",\n \"code\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "be8248b1-1924-4eb3-b41e-50fd1fd23f46", "name": "Fail run", "request": { "name": "Fail run", "description": { "content": "\nSets `status='failed'`, stores `error_summary`. The committed cursor\nis **not** advanced — the next `begin` hands out the same lower bound,\nso the failed window will be re-fetched on the next attempt.\n\nFailures are NOT written to `delta_audit_log`. They are routine and would\ndwarf the security-relevant cursor mutations. Use stderr / connector logs\nfor failure history.\n ", "type": "text/plain" }, "url": { "path": [ "v1", "delta", "streams", ":connector", ":stream", "fail" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "connector", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "stream", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"error_summary\": \"\",\n \"metadata\": {\n \"key_0\": 7128.966020564858,\n \"key_1\": 2807.1505018123257,\n \"key_2\": 4305.479983088283,\n \"key_3\": 1343\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "d42d0f16-af25-44a2-a623-9132f97ebe77", "name": "Run marked failed", "originalRequest": { "url": { "path": [ "v1", "delta", "streams", ":connector", ":stream", "fail" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "connector", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "stream", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"error_summary\": \"\",\n \"metadata\": {\n \"key_0\": 9852.172287727764,\n \"key_1\": \"string\",\n \"key_2\": \"string\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": true\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1b052668-f020-49a5-87f6-a63350eec1ea", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1", "delta", "streams", ":connector", ":stream", "fail" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "connector", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "stream", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"error_summary\": \"\",\n \"metadata\": {\n \"key_0\": 9852.172287727764,\n \"key_1\": \"string\",\n \"key_2\": \"string\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"string\",\n \"code\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "86bea5dd-ca63-498a-860f-e712740df8f8", "name": "Forbidden — missing DELTA_WRITE", "originalRequest": { "url": { "path": [ "v1", "delta", "streams", ":connector", ":stream", "fail" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "connector", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "stream", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"error_summary\": \"\",\n \"metadata\": {\n \"key_0\": 9852.172287727764,\n \"key_1\": \"string\",\n \"key_2\": \"string\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"string\",\n \"code\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "83b51699-62bb-4d34-9a66-75d21e911839", "name": "Stream not found", "originalRequest": { "url": { "path": [ "v1", "delta", "streams", ":connector", ":stream", "fail" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "connector", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "stream", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"error_summary\": \"\",\n \"metadata\": {\n \"key_0\": 9852.172287727764,\n \"key_1\": \"string\",\n \"key_2\": \"string\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"STREAM_NOT_FOUND\",\n \"message\": \"No delta_stream_state row for coupa/invoices\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "51b03c87-0428-4ecf-ae06-2fb2618c36c8", "name": "Internal server error", "originalRequest": { "url": { "path": [ "v1", "delta", "streams", ":connector", ":stream", "fail" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "connector", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "stream", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"error_summary\": \"\",\n \"metadata\": {\n \"key_0\": 9852.172287727764,\n \"key_1\": \"string\",\n \"key_2\": \"string\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"string\",\n \"code\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b05e11be-251a-4e66-b978-13a458fced47", "name": "Reset cursor", "request": { "name": "Reset cursor", "description": { "content": "\nForcibly sets `committed_cursor_value` to `new_cursor_value` regardless\nof monotonicity. Use this to backfill (move cursor backwards to re-fetch a\nwindow) or to skip ahead (move cursor forwards past corrupt data).\n\nRequires `DELTA_RESET` on the external API or `delta_admin` operation\non the internal API. Connector job tokens do NOT have this — only admin\nroutines / on-call playbooks should call it.\n\nAlways writes a row to `delta_audit_log` with `event_type='cursor_reset'`,\nthe previous and new cursors, the calling api_user, and the supplied\n`reason`. `reason` is required.\n ", "type": "text/plain" }, "url": { "path": [ "v1", "delta", "streams", ":connector", ":stream", "reset" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "connector", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "stream", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"cursor_type\": \"\",\n \"new_cursor_value\": \"\",\n \"reason\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "65581fd3-20ab-424e-9bbb-b06f04015d6e", "name": "Cursor reset", "originalRequest": { "url": { "path": [ "v1", "delta", "streams", ":connector", ":stream", "reset" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "connector", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "stream", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"cursor_type\": \"\",\n \"new_cursor_value\": \"\",\n \"reason\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": true,\n \"previous_cursor\": \"string\",\n \"new_cursor\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ac54a433-02bf-421a-b367-22a1d5001de8", "name": "Bad request", "originalRequest": { "url": { "path": [ "v1", "delta", "streams", ":connector", ":stream", "reset" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "connector", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "stream", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"cursor_type\": \"\",\n \"new_cursor_value\": \"\",\n \"reason\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"MISSING_REASON\",\n \"message\": \"reason is required for cursor reset\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7a3347ac-145e-4c38-99d4-0f12d18b6303", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1", "delta", "streams", ":connector", ":stream", "reset" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "connector", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "stream", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"cursor_type\": \"\",\n \"new_cursor_value\": \"\",\n \"reason\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"string\",\n \"code\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aaae6d1b-bd36-4994-8781-33c2f8119017", "name": "Forbidden — missing DELTA_RESET", "originalRequest": { "url": { "path": [ "v1", "delta", "streams", ":connector", ":stream", "reset" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "connector", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "stream", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"cursor_type\": \"\",\n \"new_cursor_value\": \"\",\n \"reason\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"string\",\n \"code\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "787fb5d5-f3ad-4adf-8b63-a8f3d829962f", "name": "Invalid cursor_type or cursor value", "originalRequest": { "url": { "path": [ "v1", "delta", "streams", ":connector", ":stream", "reset" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "connector", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "stream", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"cursor_type\": \"\",\n \"new_cursor_value\": \"\",\n \"reason\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"INVALID_CURSOR_TYPE\",\n \"message\": \"cursor_type must be one of timestamp_utc, numeric_id, opaque_token\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0175d32b-fd63-47ac-a1f3-3ca1add62c46", "name": "Internal server error", "originalRequest": { "url": { "path": [ "v1", "delta", "streams", ":connector", ":stream", "reset" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "connector", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "stream", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"cursor_type\": \"\",\n \"new_cursor_value\": \"\",\n \"reason\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"string\",\n \"code\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "88817e81-cd2b-4a8c-b545-83e47235fddc", "name": "Invoice", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "155cbd6e-5b2c-426c-95ff-d5e634e7eac6", "name": "List invoice tokens", "request": { "name": "List invoice tokens", "description": {}, "url": { "path": [ "v1", "invoices" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "state", "value": "", "description": "(Required) pendingIntegration, pendingAcknowledgement, pendingResult" }, { "disabled": true, "key": "page", "value": "1" }, { "disabled": true, "key": "limit", "value": "100" }, { "disabled": true, "key": "ext_reference_1", "value": "", "description": "Case-insensitive filter (ILIKE). Only applied when state=pendingIntegration. Pass %value% for substring." }, { "disabled": true, "key": "ext_reference_2", "value": "", "description": "Case-insensitive filter (ILIKE). Only applied when state=pendingIntegration. Pass %value% for substring." }, { "disabled": true, "key": "ext_reference_3", "value": "", "description": "Case-insensitive filter (ILIKE). Only applied when state=pendingIntegration. Pass %value% for substring." }, { "disabled": true, "key": "ext_reference_4", "value": "", "description": "Case-insensitive filter (ILIKE). Only applied when state=pendingIntegration. Pass %value% for substring." }, { "disabled": true, "key": "ext_reference_5", "value": "", "description": "Case-insensitive filter (ILIKE). Only applied when state=pendingIntegration. Pass %value% for substring." } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "cec76bc9-2be2-461f-8bf4-d935e7a6191a", "name": "Tokens only", "originalRequest": { "url": { "path": [ "v1", "invoices" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "state", "value": "" }, { "key": "page", "value": "1" }, { "key": "limit", "value": "100" }, { "key": "ext_reference_1", "value": "" }, { "key": "ext_reference_2", "value": "" }, { "key": "ext_reference_3", "value": "" }, { "key": "ext_reference_4", "value": "" }, { "key": "ext_reference_5", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"count\": 4858,\n \"page\": 789,\n \"totalPages\": 2570,\n \"records\": [\n {\n \"invoice_token\": \"233faa9e-6c06-2037-1385-14cb9b97bdc2\"\n },\n {\n \"invoice_token\": \"b16e2f7d-ff3d-aa60-1c1b-b3e0a367b5d0\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9961470c-57ad-4479-a905-02a39408ee7c", "name": "Missing/invalid state", "originalRequest": { "url": { "path": [ "v1", "invoices" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "state", "value": "" }, { "key": "page", "value": "1" }, { "key": "limit", "value": "100" }, { "key": "ext_reference_1", "value": "" }, { "key": "ext_reference_2", "value": "" }, { "key": "ext_reference_3", "value": "" }, { "key": "ext_reference_4", "value": "" }, { "key": "ext_reference_5", "value": "" } ], "variable": [] }, "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "8b02d7c9-9361-4b34-8078-a5d5b42dcad6", "name": "Missing required permission", "originalRequest": { "url": { "path": [ "v1", "invoices" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "state", "value": "" }, { "key": "page", "value": "1" }, { "key": "limit", "value": "100" }, { "key": "ext_reference_1", "value": "" }, { "key": "ext_reference_2", "value": "" }, { "key": "ext_reference_3", "value": "" }, { "key": "ext_reference_4", "value": "" }, { "key": "ext_reference_5", "value": "" } ], "variable": [] }, "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d560d18a-215e-47f5-8bad-acfeadb53e63", "name": "Server error", "originalRequest": { "url": { "path": [ "v1", "invoices" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "state", "value": "" }, { "key": "page", "value": "1" }, { "key": "limit", "value": "100" }, { "key": "ext_reference_1", "value": "" }, { "key": "ext_reference_2", "value": "" }, { "key": "ext_reference_3", "value": "" }, { "key": "ext_reference_4", "value": "" }, { "key": "ext_reference_5", "value": "" } ], "variable": [] }, "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b65b40b1-1f20-47bf-a603-973082c19693", "name": "Claim invoices for integration", "request": { "name": "Claim invoices for integration", "description": {}, "url": { "path": [ "v1", "invoices", "claim" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"state\": \"PendingIntegration\",\n \"limit\": 1,\n \"lease_ttl_seconds\": 300,\n \"idempotency_key\": \"\",\n \"filter\": {\n \"ext_reference_1\": \"\",\n \"ext_reference_2\": \"\",\n \"ext_reference_3\": \"\",\n \"ext_reference_4\": \"\",\n \"ext_reference_5\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "14ba1794-c8f9-4d52-bbe7-1decfcd237f9", "name": "Claimed leases (by token)", "originalRequest": { "url": { "path": [ "v1", "invoices", "claim" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"state\": \"PendingIntegration\",\n \"limit\": 1,\n \"lease_ttl_seconds\": 300,\n \"idempotency_key\": \"\",\n \"filter\": {\n \"ext_reference_1\": \"\",\n \"ext_reference_2\": \"\",\n \"ext_reference_3\": \"\",\n \"ext_reference_4\": \"\",\n \"ext_reference_5\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"leases\": [\n {\n \"invoice_token\": \"string\",\n \"lease_expires_at\": \"2003-12-23T19:16:06.052Z\",\n \"lease_token\": \"7b9536a8-b7eb-4879-aa21-84176d251ac7\"\n },\n {\n \"invoice_token\": \"string\",\n \"lease_expires_at\": \"1982-02-17T16:35:33.507Z\",\n \"lease_token\": \"72ef4a6b-387d-3d28-d787-0ee949a6d4c1\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "11764ecd-3d70-48d3-a111-04262b128c0b", "name": "Invalid state or input", "originalRequest": { "url": { "path": [ "v1", "invoices", "claim" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"state\": \"PendingIntegration\",\n \"limit\": 1,\n \"lease_ttl_seconds\": 300,\n \"idempotency_key\": \"\",\n \"filter\": {\n \"ext_reference_1\": \"\",\n \"ext_reference_2\": \"\",\n \"ext_reference_3\": \"\",\n \"ext_reference_4\": \"\",\n \"ext_reference_5\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a764ea82-6e8d-4a46-8f7a-aa326d1c4e61", "name": "Missing required permission", "originalRequest": { "url": { "path": [ "v1", "invoices", "claim" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"state\": \"PendingIntegration\",\n \"limit\": 1,\n \"lease_ttl_seconds\": 300,\n \"idempotency_key\": \"\",\n \"filter\": {\n \"ext_reference_1\": \"\",\n \"ext_reference_2\": \"\",\n \"ext_reference_3\": \"\",\n \"ext_reference_4\": \"\",\n \"ext_reference_5\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "6b9d3984-801d-4ab5-9a96-5d7becc2f9bc", "name": "Server error", "originalRequest": { "url": { "path": [ "v1", "invoices", "claim" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"state\": \"PendingIntegration\",\n \"limit\": 1,\n \"lease_ttl_seconds\": 300,\n \"idempotency_key\": \"\",\n \"filter\": {\n \"ext_reference_1\": \"\",\n \"ext_reference_2\": \"\",\n \"ext_reference_3\": \"\",\n \"ext_reference_4\": \"\",\n \"ext_reference_5\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "70f28db6-394e-4d4d-b1a8-011cd1c97ea8", "name": "Get invoice detail by token", "request": { "name": "Get invoice detail by token", "description": {}, "url": { "path": [ "v1", "invoices", ":token" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "key": "includeNull", "value": "false", "description": "If true, include fields with null/empty values in invoice.fields and lines[].fields" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "token", "description": "(Required) invoice_token" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "23c92c03-6747-40df-b249-5fbc9af672f4", "name": "Invoice detail", "originalRequest": { "url": { "path": [ "v1", "invoices", ":token" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "includeNull", "value": "false" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "token", "description": "(Required) invoice_token" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"email\": {\n \"email_token\": \"8ef17a34-82e8-84e0-1ea3-e15285da039f\",\n \"eml_from\": \"string\",\n \"eml_to\": \"string\",\n \"eml_replyto\": \"string\",\n \"eml_subject\": \"string\",\n \"eml_body\": \"string\",\n \"eml_received\": \"2002-09-19T16:55:59.421Z\"\n },\n \"invoice\": {\n \"id\": 5092,\n \"status\": 9415,\n \"invoice_token\": \"65bcff80-65ae-fdd9-7abd-15c5d49f3b55\",\n \"fields\": [\n {\n \"key\": \"string\",\n \"label\": \"string\",\n \"value\": {}\n },\n {\n \"key\": \"string\",\n \"label\": \"string\",\n \"value\": {}\n }\n ],\n \"status_info\": {\n \"code\": 6563,\n \"key\": \"string\",\n \"label\": \"string\",\n \"description\": \"string\"\n },\n \"email_token\": \"53e1021a-7363-4ae9-a1e0-74273e40351f\",\n \"created_at\": \"1983-04-09T13:44:10.560Z\",\n \"updated_at\": \"2004-04-27T22:50:12.398Z\"\n },\n \"lines\": [\n {\n \"id\": 491,\n \"invoice_id\": 7047,\n \"fields\": [\n {\n \"key\": \"string\",\n \"label\": \"string\",\n \"value\": {}\n },\n {\n \"key\": \"string\",\n \"label\": \"string\",\n \"value\": {}\n }\n ],\n \"invoice_line_number\": 3694,\n \"created_at\": \"2013-03-27T11:47:24.908Z\",\n \"updated_at\": \"2006-06-18T17:29:59.436Z\"\n },\n {\n \"id\": 8251,\n \"invoice_id\": 7097,\n \"fields\": [\n {\n \"key\": \"string\",\n \"label\": \"string\",\n \"value\": {}\n },\n {\n \"key\": \"string\",\n \"label\": \"string\",\n \"value\": {}\n }\n ],\n \"invoice_line_number\": 3411,\n \"created_at\": \"2005-02-20T18:51:16.720Z\",\n \"updated_at\": \"2022-10-19T05:37:08.842Z\"\n }\n ],\n \"addresses\": [\n {\n \"address_type\": \"string\",\n \"address_name\": \"string\",\n \"street\": \"string\",\n \"city\": \"string\",\n \"state\": \"string\",\n \"postal_code\": \"string\",\n \"country\": \"string\"\n },\n {\n \"address_type\": \"string\",\n \"address_name\": \"string\",\n \"street\": \"string\",\n \"city\": \"string\",\n \"state\": \"string\",\n \"postal_code\": \"string\",\n \"country\": \"string\"\n }\n ],\n \"taxes\": [\n {\n \"tax_name\": \"string\",\n \"tax_rate\": 7081.654570589863,\n \"tax_base_amount\": 2125.376655538387,\n \"tax_amount\": 5163.057623235465,\n \"tax_description\": \"string\"\n },\n {\n \"tax_name\": \"string\",\n \"tax_rate\": 9998.777105520812,\n \"tax_base_amount\": 3216.7689286874747,\n \"tax_amount\": 4711.516169195378,\n \"tax_description\": \"string\"\n }\n ],\n \"charges\": [\n {\n \"charge_name\": \"string\",\n \"charge_amount\": 6191.094214404314\n },\n {\n \"charge_name\": \"string\",\n \"charge_amount\": 1679.2897349286307\n }\n ],\n \"discounts\": [\n {\n \"discount_description\": \"string\",\n \"discount_rate\": 1741.7262934088317,\n \"discount_amount\": 4691.1383516769,\n \"discount_due_date\": \"1980-12-27T20:10:35.712Z\",\n \"due_date_basis\": \"1946-10-02T10:50:40.805Z\",\n \"due_date_period_value\": 3843.07950306199,\n \"due_date_period_measure\": \"WEEK\"\n },\n {\n \"discount_description\": \"string\",\n \"discount_rate\": 4713.999235118844,\n \"discount_amount\": 5672.20282953191,\n \"discount_due_date\": \"2007-06-04T20:33:26.066Z\",\n \"due_date_basis\": \"1988-11-14T20:18:07.543Z\",\n \"due_date_period_value\": 5942.448056175959,\n \"due_date_period_measure\": \"WEEK\"\n }\n ],\n \"attachments\": [\n {\n \"attachment_token\": \"cd761625-5d5a-c8d5-50a2-64e0c2bd9e2f\",\n \"file_name\": \"string\",\n \"content_type\": \"string\",\n \"type\": \"EMAIL\",\n \"parent_token\": \"string\"\n },\n {\n \"attachment_token\": \"dc358fba-5504-96ed-684f-784dcd70635e\",\n \"file_name\": \"string\",\n \"content_type\": \"string\",\n \"type\": \"EMAIL\",\n \"parent_token\": \"string\"\n }\n ],\n \"matchAI\": [\n {\n \"id\": 145,\n \"invoice_id\": 7099,\n \"order_number_1\": \"string\",\n \"order_line_number_1\": 2434,\n \"product_code_1\": \"string\",\n \"receipt_number\": \"string\",\n \"receipt_line_number\": 683,\n \"quantity\": 7836.974266876311,\n \"unit_price\": 4657.483847519395,\n \"unit_of_measure\": \"string\",\n \"net_amount\": 8682.83233739069,\n \"confidence_score\": 351.7236337228402,\n \"reason\": \"string\",\n \"created_at\": \"1955-07-02T14:28:33.758Z\",\n \"updated_at\": \"1999-05-14T03:01:59.590Z\"\n },\n {\n \"id\": 9565,\n \"invoice_id\": 1458,\n \"order_number_1\": \"string\",\n \"order_line_number_1\": 7500,\n \"product_code_1\": \"string\",\n \"receipt_number\": \"string\",\n \"receipt_line_number\": 4434,\n \"quantity\": 3173.660331408126,\n \"unit_price\": 3156.773920059237,\n \"unit_of_measure\": \"string\",\n \"net_amount\": 7149.546117386975,\n \"confidence_score\": 2676.1938256204544,\n \"reason\": \"string\",\n \"created_at\": \"1959-12-13T19:08:31.833Z\",\n \"updated_at\": \"2019-05-04T04:12:01.303Z\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b7b7f51b-a0fd-4bb1-8e83-0db744040e0e", "name": "Invalid token format", "originalRequest": { "url": { "path": [ "v1", "invoices", ":token" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "includeNull", "value": "false" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "token", "description": "(Required) invoice_token" } ] }, "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "8ee56223-b69b-4256-812b-bb12545004e6", "name": "Missing required permission", "originalRequest": { "url": { "path": [ "v1", "invoices", ":token" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "includeNull", "value": "false" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "token", "description": "(Required) invoice_token" } ] }, "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "0e276c53-5959-4f1d-9a1a-d51f94259318", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "invoices", ":token" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "includeNull", "value": "false" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "token", "description": "(Required) invoice_token" } ] }, "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "9c3519eb-f8cb-4847-b80e-6de89300fce7", "name": "Server error", "originalRequest": { "url": { "path": [ "v1", "invoices", ":token" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "includeNull", "value": "false" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "token", "description": "(Required) invoice_token" } ] }, "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4a79a5bc-d7ed-416f-af51-698a9d74595e", "name": "Acknowledge invoice receipt", "request": { "name": "Acknowledge invoice receipt", "description": {}, "url": { "path": [ "v1", "invoices", ":token", "acknowledge" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "token", "description": "(Required) invoice_token" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null }, "response": [ { "id": "0cf083e9-2c58-4e0f-88d7-deb5ecbb12ff", "name": "Acknowledged", "originalRequest": { "url": { "path": [ "v1", "invoices", ":token", "acknowledge" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "token", "description": "(Required) invoice_token" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": true,\n \"previous_status\": \"PendingIntegration\",\n \"new_status\": \"PendingResult\",\n \"invoice_id\": 123456,\n \"status_changed\": true\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a688c751-db1d-4093-9863-ee8747ce7410", "name": "Invalid token format", "originalRequest": { "url": { "path": [ "v1", "invoices", ":token", "acknowledge" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "token", "description": "(Required) invoice_token" } ] }, "method": "POST", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "96471c9d-58ab-4d25-82f6-10237ee045d5", "name": "Missing required permission", "originalRequest": { "url": { "path": [ "v1", "invoices", ":token", "acknowledge" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "token", "description": "(Required) invoice_token" } ] }, "method": "POST", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e9d130de-a330-4586-a4f8-ebb40f7baf32", "name": "Invoice not found", "originalRequest": { "url": { "path": [ "v1", "invoices", ":token", "acknowledge" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "token", "description": "(Required) invoice_token" } ] }, "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "7c967bee-b4cb-4cf4-92a4-c5d3e0fb00a6", "name": "Invoice not eligible for acknowledgement (not in 90/91/92/93)", "originalRequest": { "url": { "path": [ "v1", "invoices", ":token", "acknowledge" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "token", "description": "(Required) invoice_token" } ] }, "method": "POST", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a79665ed-6685-497a-96ca-4d528fc69617", "name": "Server error", "originalRequest": { "url": { "path": [ "v1", "invoices", ":token", "acknowledge" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "token", "description": "(Required) invoice_token" } ] }, "method": "POST", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "bc4fb21d-9871-46a8-b7d8-f31c59f84e76", "name": "Post integration result", "request": { "name": "Post integration result", "description": {}, "url": { "path": [ "v1", "invoices", ":token", "integration-result" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "token", "description": "(Required) Invoice token identifier." } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"success\": \"\",\n \"force_override\": false,\n \"external_id_1\": \"\",\n \"external_message_1\": \"\",\n \"external_id_2\": \"\",\n \"external_message_2\": \"\",\n \"external_id_3\": \"\",\n \"external_message_3\": \"\",\n \"failed_code\": \"\",\n \"failure_code\": \"\",\n \"failure_message\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "931d0566-f210-4a82-8709-326b85190e2a", "name": "Integration result applied.", "originalRequest": { "url": { "path": [ "v1", "invoices", ":token", "integration-result" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "token", "description": "(Required) Invoice token identifier." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"success\": true,\n \"external_id_1\": \"ERPx-12345\",\n \"external_message_1\": \"OK\",\n \"external_id_2\": \"ERPx-67890\",\n \"external_message_2\": \"POSTED\",\n \"external_id_3\": \"ERPx-24680\",\n \"external_message_3\": \"POSTED\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ok\": true,\n \"previous_status\": \"PendingResult\",\n \"new_status\": \"Processed\",\n \"invoice_token\": \"750e8400-e29b-41d4-a716-446655440002\",\n \"status_changed\": true\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1e242380-86c9-4400-8d59-5e2538a50eb9", "name": "Invalid token format", "originalRequest": { "url": { "path": [ "v1", "invoices", ":token", "integration-result" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "token", "description": "(Required) Invoice token identifier." } ] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"success\": true,\n \"external_id_1\": \"ERPx-12345\",\n \"external_message_1\": \"OK\",\n \"external_id_2\": \"ERPx-67890\",\n \"external_message_2\": \"POSTED\",\n \"external_id_3\": \"ERPx-24680\",\n \"external_message_3\": \"POSTED\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "8ba9944f-51eb-4f58-bde3-3f43499d4b7d", "name": "Missing required permission", "originalRequest": { "url": { "path": [ "v1", "invoices", ":token", "integration-result" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "token", "description": "(Required) Invoice token identifier." } ] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"success\": true,\n \"external_id_1\": \"ERPx-12345\",\n \"external_message_1\": \"OK\",\n \"external_id_2\": \"ERPx-67890\",\n \"external_message_2\": \"POSTED\",\n \"external_id_3\": \"ERPx-24680\",\n \"external_message_3\": \"POSTED\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "dec7010a-6a53-4696-a826-de8815910e14", "name": "Invoice not found (or no row updated).", "originalRequest": { "url": { "path": [ "v1", "invoices", ":token", "integration-result" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "token", "description": "(Required) Invoice token identifier." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"success\": true,\n \"external_id_1\": \"ERPx-12345\",\n \"external_message_1\": \"OK\",\n \"external_id_2\": \"ERPx-67890\",\n \"external_message_2\": \"POSTED\",\n \"external_id_3\": \"ERPx-24680\",\n \"external_message_3\": \"POSTED\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Invoice not found for update\",\n \"code\": \"NO_UPDATE\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "668a1aee-de35-451f-aa1f-50847ec4ed19", "name": "Conflict (e.g., reverting 100 to failed without force_override).", "originalRequest": { "url": { "path": [ "v1", "invoices", ":token", "integration-result" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "token", "description": "(Required) Invoice token identifier." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"success\": true,\n \"external_id_1\": \"ERPx-12345\",\n \"external_message_1\": \"OK\",\n \"external_id_2\": \"ERPx-67890\",\n \"external_message_2\": \"POSTED\",\n \"external_id_3\": \"ERPx-24680\",\n \"external_message_3\": \"POSTED\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Invoice already SUCCESS (100). Provide force_override=true to mark failed.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4854608b-4890-416b-8158-750079fa2362", "name": "Server error", "originalRequest": { "url": { "path": [ "v1", "invoices", ":token", "integration-result" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "token", "description": "(Required) Invoice token identifier." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"success\": true,\n \"external_id_1\": \"ERPx-12345\",\n \"external_message_1\": \"OK\",\n \"external_id_2\": \"ERPx-67890\",\n \"external_message_2\": \"POSTED\",\n \"external_id_3\": \"ERPx-24680\",\n \"external_message_3\": \"POSTED\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"string\",\n \"code\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "47888bca-9c89-4c2d-8807-fffcd9287bef", "name": "Lifecycle Messages", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "f1955a95-b55b-45dd-8254-c6b9cd8a1079", "name": "Post lifecycle message", "request": { "name": "Post lifecycle message", "description": { "content": "External systems (ERPs, connectors) post lifecycle status updates. Supports idempotency via the Idempotency-Key header.", "type": "text/plain" }, "url": { "path": [ "v1", "invoices", ":token", "lifecycle-messages" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "token", "description": "(Required) Invoice token (invoice_token)" } ] }, "header": [ { "disabled": false, "description": "Idempotency key. If the same key is sent again for the same invoice, the original response is returned.", "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"occurred_at\": \"\",\n \"actor_display_name\": \"\",\n \"clarification_code\": \"\",\n \"note_internal\": \"\",\n \"note_supplier\": \"\",\n \"reference_type\": \"\",\n \"reference_value\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "d9fe3f38-fabe-417b-a7f0-5bc8e6f74b34", "name": "Idempotent duplicate — original message returned", "originalRequest": { "url": { "path": [ "v1", "invoices", ":token", "lifecycle-messages" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "token", "description": "(Required) Invoice token (invoice_token)" } ] }, "header": [ { "disabled": false, "description": "Idempotency key. If the same key is sent again for the same invoice, the original response is returned.", "key": "Idempotency-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"APPROVED\",\n \"actor_display_name\": \"SAP S/4HANA – ACME Corp\",\n \"note_internal\": \"Approved by budget owner via SAP workflow WF-44821.\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "22829571-3428-4fd0-9811-108c43520fbf", "name": "Lifecycle message created", "originalRequest": { "url": { "path": [ "v1", "invoices", ":token", "lifecycle-messages" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "token", "description": "(Required) Invoice token (invoice_token)" } ] }, "header": [ { "disabled": false, "description": "Idempotency key. If the same key is sent again for the same invoice, the original response is returned.", "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"APPROVED\",\n \"actor_display_name\": \"SAP S/4HANA – ACME Corp\",\n \"note_internal\": \"Approved by budget owner via SAP workflow WF-44821.\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"9aac54a8-715c-b2ce-ed79-fec929a92797\",\n \"invoice_id\": \"3492a619-29bb-6c26-815e-835a9b36a591\",\n \"code\": \"APPROVED\",\n \"source\": \"MANUAL_USER\",\n \"occurred_at\": \"2007-02-08T13:23:25.114Z\",\n \"recorded_at\": \"2016-11-03T12:06:34.870Z\",\n \"actor_display_name\": \"string\",\n \"clarification_code\": \"string\",\n \"note_supplier\": \"string\",\n \"reference_type\": \"PAYMENT_REF\",\n \"reference_value\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "433e5841-ac1a-436a-8edb-76c2bcdc1c04", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "invoices", ":token", "lifecycle-messages" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "token", "description": "(Required) Invoice token (invoice_token)" } ] }, "header": [ { "disabled": false, "description": "Idempotency key. If the same key is sent again for the same invoice, the original response is returned.", "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"APPROVED\",\n \"actor_display_name\": \"SAP S/4HANA – ACME Corp\",\n \"note_internal\": \"Approved by budget owner via SAP workflow WF-44821.\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"INVALID_CODE\",\n \"message\": \"Unknown lifecycle code: NOT_A_REAL_CODE\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "805af913-bb5c-4202-a272-4107a3336aaf", "name": "Invoice not found", "originalRequest": { "url": { "path": [ "v1", "invoices", ":token", "lifecycle-messages" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "token", "description": "(Required) Invoice token (invoice_token)" } ] }, "header": [ { "disabled": false, "description": "Idempotency key. If the same key is sent again for the same invoice, the original response is returned.", "key": "Idempotency-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"APPROVED\",\n \"actor_display_name\": \"SAP S/4HANA – ACME Corp\",\n \"note_internal\": \"Approved by budget owner via SAP workflow WF-44821.\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "eb776b35-4405-40f0-82fc-83cf15d49d42", "name": "State transition invalid or terminal state", "originalRequest": { "url": { "path": [ "v1", "invoices", ":token", "lifecycle-messages" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "token", "description": "(Required) Invoice token (invoice_token)" } ] }, "header": [ { "disabled": false, "description": "Idempotency key. If the same key is sent again for the same invoice, the original response is returned.", "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"APPROVED\",\n \"actor_display_name\": \"SAP S/4HANA – ACME Corp\",\n \"note_internal\": \"Approved by budget owner via SAP workflow WF-44821.\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"TERMINAL_STATE\",\n \"message\": \"string\",\n \"current_latest_code\": \"string\",\n \"valid_next_codes\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3bd55020-e92c-45b2-84f5-6068b0c07913", "name": "Invoice not yet in integration-ready state", "originalRequest": { "url": { "path": [ "v1", "invoices", ":token", "lifecycle-messages" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "token", "description": "(Required) Invoice token (invoice_token)" } ] }, "header": [ { "disabled": false, "description": "Idempotency key. If the same key is sent again for the same invoice, the original response is returned.", "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"APPROVED\",\n \"actor_display_name\": \"SAP S/4HANA – ACME Corp\",\n \"note_internal\": \"Approved by budget owner via SAP workflow WF-44821.\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"INVOICE_NOT_READY\",\n \"message\": \"Invoice has not yet reached integration-ready state.\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9d0e103a-48f6-4922-97c4-bfea4bd6adeb", "name": "Get lifecycle log", "request": { "name": "Get lifecycle log", "description": { "content": "Returns the full ordered lifecycle message log. Internal notes are only included if the API key has LIFECYCLE_READ_INTERNAL permission and include_internal_notes=true.", "type": "text/plain" }, "url": { "path": [ "v1", "invoices", ":token", "lifecycle-messages" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "key": "include_internal_notes", "value": "false", "description": "Include note_internal in results (requires LIFECYCLE_READ_INTERNAL permission)." }, { "disabled": true, "key": "tier", "value": "all", "description": "Filter by message tier: 1=Intake, 2=Buyer-Side, 3=Financial." } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "token", "description": "(Required) Invoice token (invoice_token)" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "441b4d7a-b52b-4482-ac8c-28c0ce03df27", "name": "Lifecycle message log", "originalRequest": { "url": { "path": [ "v1", "invoices", ":token", "lifecycle-messages" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "include_internal_notes", "value": "false" }, { "key": "tier", "value": "all" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "token", "description": "(Required) Invoice token (invoice_token)" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"invoice_id\": \"f131f148-9b19-776f-b328-671cf77c0582\",\n \"messages\": [\n {\n \"id\": \"1d043ef2-42ee-8d01-9857-eb547639c258\",\n \"code\": \"string\",\n \"source\": \"NUNTIQ\",\n \"actor_type\": \"USER\",\n \"occurred_at\": \"2026-02-20T12:49:19.954Z\",\n \"recorded_at\": \"1991-09-09T07:03:55.874Z\",\n \"actor_id\": \"string\",\n \"actor_display_name\": \"string\",\n \"clarification_code\": \"string\",\n \"note_internal\": \"string\",\n \"note_supplier\": \"string\",\n \"reference_type\": \"CREDIT_NOTE\",\n \"reference_value\": \"string\"\n },\n {\n \"id\": \"d7da7194-6487-ac5d-0343-7bbb212aa3ca\",\n \"code\": \"string\",\n \"source\": \"EXTERNAL_API\",\n \"actor_type\": \"USER\",\n \"occurred_at\": \"1979-01-06T18:30:35.783Z\",\n \"recorded_at\": \"1957-02-02T22:55:59.665Z\",\n \"actor_id\": \"string\",\n \"actor_display_name\": \"string\",\n \"clarification_code\": \"string\",\n \"note_internal\": \"string\",\n \"note_supplier\": \"string\",\n \"reference_type\": \"PAYMENT_REF\",\n \"reference_value\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "97c88d50-1add-4a9f-9e3d-4943d0aca91e", "name": "Invalid token format", "originalRequest": { "url": { "path": [ "v1", "invoices", ":token", "lifecycle-messages" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "include_internal_notes", "value": "false" }, { "key": "tier", "value": "all" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "token", "description": "(Required) Invoice token (invoice_token)" } ] }, "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "0f033895-5c00-47a0-892f-9688ae507148", "name": "Invoice not found", "originalRequest": { "url": { "path": [ "v1", "invoices", ":token", "lifecycle-messages" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "include_internal_notes", "value": "false" }, { "key": "tier", "value": "all" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "token", "description": "(Required) Invoice token (invoice_token)" } ] }, "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "dd0bc282-d706-421b-80ed-c0cf85095ab8", "name": "Post lifecycle message by reference", "request": { "name": "Post lifecycle message by reference", "description": { "content": "Alternative to the token-based endpoint. Resolves the invoice by invoice_number and optional supplier_code/location/company code. Returns 409 AMBIGUOUS_REFERENCE if multiple invoices match.", "type": "text/plain" }, "url": { "path": [ "v1", "invoices", "by-reference", "lifecycle-messages" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Idempotency key.", "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"invoice_number\": \"\",\n \"code\": \"\",\n \"supplier_code\": \"\",\n \"supplier_location_code\": \"\",\n \"erp_company_code\": \"\",\n \"occurred_at\": \"\",\n \"actor_display_name\": \"\",\n \"clarification_code\": \"\",\n \"note_internal\": \"\",\n \"note_supplier\": \"\",\n \"reference_type\": \"\",\n \"reference_value\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "3f4afffd-e048-471b-ad0f-a9aeb3a7fd60", "name": "Idempotent duplicate", "originalRequest": { "url": { "path": [ "v1", "invoices", "by-reference", "lifecycle-messages" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Idempotency key.", "key": "Idempotency-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"invoice_number\": \"INV-2026-001\",\n \"supplier_code\": \"SUP-100\",\n \"code\": \"IN_PROCESS\",\n \"actor_display_name\": \"SAP S/4HANA\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "299ad5e0-a908-4060-b094-4381baf3125f", "name": "Lifecycle message created", "originalRequest": { "url": { "path": [ "v1", "invoices", "by-reference", "lifecycle-messages" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Idempotency key.", "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"invoice_number\": \"INV-2026-001\",\n \"supplier_code\": \"SUP-100\",\n \"code\": \"IN_PROCESS\",\n \"actor_display_name\": \"SAP S/4HANA\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"9aac54a8-715c-b2ce-ed79-fec929a92797\",\n \"invoice_id\": \"3492a619-29bb-6c26-815e-835a9b36a591\",\n \"code\": \"APPROVED\",\n \"source\": \"MANUAL_USER\",\n \"occurred_at\": \"2007-02-08T13:23:25.114Z\",\n \"recorded_at\": \"2016-11-03T12:06:34.870Z\",\n \"actor_display_name\": \"string\",\n \"clarification_code\": \"string\",\n \"note_supplier\": \"string\",\n \"reference_type\": \"PAYMENT_REF\",\n \"reference_value\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3fc83581-6383-4a0d-ba89-fe2b8b514d4d", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "invoices", "by-reference", "lifecycle-messages" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Idempotency key.", "key": "Idempotency-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"invoice_number\": \"INV-2026-001\",\n \"supplier_code\": \"SUP-100\",\n \"code\": \"IN_PROCESS\",\n \"actor_display_name\": \"SAP S/4HANA\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "2eda8501-b33d-416b-bf75-af962509dc93", "name": "No invoice matches the provided reference", "originalRequest": { "url": { "path": [ "v1", "invoices", "by-reference", "lifecycle-messages" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Idempotency key.", "key": "Idempotency-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"invoice_number\": \"INV-2026-001\",\n \"supplier_code\": \"SUP-100\",\n \"code\": \"IN_PROCESS\",\n \"actor_display_name\": \"SAP S/4HANA\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d5630b34-6d53-4d75-b7e3-125477af4220", "name": "Ambiguous reference or transition invalid", "originalRequest": { "url": { "path": [ "v1", "invoices", "by-reference", "lifecycle-messages" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Idempotency key.", "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"invoice_number\": \"INV-2026-001\",\n \"supplier_code\": \"SUP-100\",\n \"code\": \"IN_PROCESS\",\n \"actor_display_name\": \"SAP S/4HANA\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"TERMINAL_STATE\",\n \"message\": \"string\",\n \"matching_invoice_ids\": [\n \"f1ba94af-a1e4-29ca-2e0d-9071a4625892\",\n \"72f9dc60-0398-9424-67ff-828fd491a122\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "78c1ed00-0c02-4651-8136-1548506a851b", "name": "Invoice not yet in integration-ready state", "originalRequest": { "url": { "path": [ "v1", "invoices", "by-reference", "lifecycle-messages" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Idempotency key.", "key": "Idempotency-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"invoice_number\": \"INV-2026-001\",\n \"supplier_code\": \"SUP-100\",\n \"code\": \"IN_PROCESS\",\n \"actor_display_name\": \"SAP S/4HANA\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "29615510-10b8-457c-9970-a8f2435b7d26", "name": "Invoice Attachments", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "fc9402c6-26e3-4f2f-9398-32c2072e2982", "name": "Upload invoice attachments", "request": { "name": "Upload invoice attachments", "description": { "content": "Upload one or more files (PDF, ZIP, images, etc.) to be used later in invoice import. Returns document tokens (UUIDs) for linking to invoices.", "type": "text/plain" }, "url": { "path": [ "v1", "invoice-attachments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "formdata", "formdata": [ { "key": "files", "type": "file", "description": "One or more files to upload (max 50MB each, max 50 files total)", "src": [] } ] } }, "response": [ { "id": "4258ae36-3946-45c1-bc4c-51de81d63d20", "name": "Files uploaded successfully", "originalRequest": { "url": { "path": [ "v1", "invoice-attachments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "One or more files to upload (max 50MB each, max 50 files total)", "type": "text/plain" }, "key": "files", "value": "[\"\",\"\"]", "type": "text" } ] } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"data\": {\n \"files_uploaded\": 3,\n \"upload_session_id\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"documents\": [\n {\n \"document_token\": \"650e8400-e29b-41d4-a716-446655440001\",\n \"file_name\": \"invoice_12345.pdf\",\n \"content_type\": \"application/pdf\",\n \"size\": 524288,\n \"is_processable\": true\n },\n {\n \"document_token\": \"650e8400-e29b-41d4-a716-446655440001\",\n \"file_name\": \"invoice_12345.pdf\",\n \"content_type\": \"application/pdf\",\n \"size\": 524288,\n \"is_processable\": true\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d0383f3d-ce14-4775-a29e-940411e2785e", "name": "Bad request - no files provided or file upload error", "originalRequest": { "url": { "path": [ "v1", "invoice-attachments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "One or more files to upload (max 50MB each, max 50 files total)", "type": "text/plain" }, "key": "files", "value": "[\"\",\"\"]", "type": "text" } ] } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e462282e-31f8-43c4-abe9-10be21d0fe88", "name": "Unauthorized - invalid API key", "originalRequest": { "url": { "path": [ "v1", "invoice-attachments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "One or more files to upload (max 50MB each, max 50 files total)", "type": "text/plain" }, "key": "files", "value": "[\"\",\"\"]", "type": "text" } ] } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "2c7634a0-f40a-4b99-831b-6d90c8b19565", "name": "Internal server error", "originalRequest": { "url": { "path": [ "v1", "invoice-attachments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "One or more files to upload (max 50MB each, max 50 files total)", "type": "text/plain" }, "key": "files", "value": "[\"\",\"\"]", "type": "text" } ] } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "767b8a45-92fb-4dea-a216-ab7b99cf5042", "name": "Invoice Import", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "eca0f7ac-be67-4590-a03b-21d1f3da1a78", "name": "Import invoice", "request": { "name": "Import invoice", "description": { "content": "Import a complete invoice with header, lines, addresses, taxes, charges, and discounts. Choose workflow to determine processing path.", "type": "text/plain" }, "url": { "path": [ "v1", "invoice-import" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Optional client-supplied unique key (max 255 chars). Repeating a request with the same Idempotency-Key returns the original invoice_token instead of creating a duplicate. Mappings expire after 24h.", "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"workflow\": \"\",\n \"invoice\": {\n \"header\": {\n \"invoice_number\": \"\",\n \"document_type\": \"\",\n \"original_invoice_number\": \"\",\n \"invoice_date\": \"\",\n \"due_date\": \"\",\n \"delivery_date\": \"\",\n \"order_number_1\": \"\",\n \"order_number_2\": \"\",\n \"contract_number\": \"\",\n \"delivery_note\": \"\",\n \"reference_number\": \"\",\n \"account_number\": \"\",\n \"net_amount\": \"\",\n \"tax_amount\": \"\",\n \"gross_amount\": \"\",\n \"currency_code\": \"\",\n \"supplier_name\": \"\",\n \"supplier_tax_id\": \"\",\n \"supplier_contact\": \"\",\n \"customer_name\": \"\",\n \"customer_tax_id\": \"\",\n \"customer_contact\": \"\",\n \"bank_account\": \"\",\n \"bank_name\": \"\",\n \"payment_method\": \"\",\n \"payment_terms\": \"\",\n \"custom_text_1\": \"\",\n \"custom_text_2\": \"\",\n \"custom_text_3\": \"\",\n \"custom_text_4\": \"\",\n \"custom_text_5\": \"\",\n \"custom_text_6\": \"\",\n \"custom_text_7\": \"\",\n \"custom_text_8\": \"\",\n \"custom_text_9\": \"\",\n \"custom_text_10\": \"\",\n \"custom_text_11\": \"\",\n \"custom_text_12\": \"\",\n \"custom_text_13\": \"\",\n \"custom_text_14\": \"\",\n \"custom_text_15\": \"\",\n \"custom_text_16\": \"\",\n \"custom_text_17\": \"\",\n \"custom_text_18\": \"\",\n \"custom_text_19\": \"\",\n \"custom_text_20\": \"\",\n \"custom_text_21\": \"\",\n \"custom_text_22\": \"\",\n \"custom_text_23\": \"\",\n \"custom_text_24\": \"\",\n \"custom_text_25\": \"\",\n \"custom_number_1\": \"\",\n \"custom_number_2\": \"\",\n \"custom_number_3\": \"\",\n \"custom_number_4\": \"\",\n \"custom_number_5\": \"\",\n \"custom_number_6\": \"\",\n \"custom_number_7\": \"\",\n \"custom_number_8\": \"\",\n \"custom_number_9\": \"\",\n \"custom_number_10\": \"\",\n \"custom_number_11\": \"\",\n \"custom_number_12\": \"\",\n \"custom_number_13\": \"\",\n \"custom_number_14\": \"\",\n \"custom_number_15\": \"\",\n \"custom_date_1\": \"\",\n \"custom_date_2\": \"\",\n \"custom_date_3\": \"\",\n \"custom_date_4\": \"\",\n \"custom_date_5\": \"\",\n \"custom_date_6\": \"\",\n \"custom_date_7\": \"\",\n \"custom_date_8\": \"\",\n \"custom_date_9\": \"\",\n \"custom_date_10\": \"\",\n \"custom_date_11\": \"\",\n \"custom_date_12\": \"\",\n \"custom_date_13\": \"\",\n \"custom_date_14\": \"\",\n \"custom_date_15\": \"\",\n \"ext_reference_1\": \"\",\n \"ext_reference_2\": \"\",\n \"ext_reference_3\": \"\",\n \"ext_reference_4\": \"\",\n \"ext_reference_5\": \"\",\n \"identifier_field_1\": \"\",\n \"identifier_field_2\": \"\",\n \"identifier_field_3\": \"\",\n \"identifier_field_4\": \"\",\n \"identifier_field_5\": \"\"\n },\n \"lines\": [\n {\n \"invoice_line_number\": \"\",\n \"product_code_1\": \"\",\n \"product_name\": \"\",\n \"product_code_2\": \"\",\n \"quantity\": \"\",\n \"unit_price\": \"\",\n \"unit_of_measure\": \"\",\n \"net_amount\": \"\",\n \"tax_amount\": \"\",\n \"tax_rate\": \"\",\n \"gross_amount\": \"\",\n \"order_number_1\": \"\",\n \"order_number_2\": \"\",\n \"delivery_date\": \"\",\n \"delivery_note\": \"\",\n \"custom_text_1\": \"\",\n \"custom_text_2\": \"\",\n \"custom_text_3\": \"\",\n \"custom_text_4\": \"\",\n \"custom_text_5\": \"\",\n \"custom_text_6\": \"\",\n \"custom_text_7\": \"\",\n \"custom_text_8\": \"\",\n \"custom_text_9\": \"\",\n \"custom_text_10\": \"\",\n \"custom_text_11\": \"\",\n \"custom_text_12\": \"\",\n \"custom_text_13\": \"\",\n \"custom_text_14\": \"\",\n \"custom_text_15\": \"\",\n \"custom_number_1\": \"\",\n \"custom_number_2\": \"\",\n \"custom_number_3\": \"\",\n \"custom_number_4\": \"\",\n \"custom_number_5\": \"\",\n \"custom_number_6\": \"\",\n \"custom_number_7\": \"\",\n \"custom_number_8\": \"\",\n \"custom_number_9\": \"\",\n \"custom_number_10\": \"\",\n \"custom_date_1\": \"\",\n \"custom_date_2\": \"\",\n \"custom_date_3\": \"\",\n \"custom_date_4\": \"\",\n \"custom_date_5\": \"\",\n \"custom_date_6\": \"\",\n \"custom_date_7\": \"\",\n \"custom_date_8\": \"\",\n \"custom_date_9\": \"\",\n \"custom_date_10\": \"\"\n },\n {\n \"invoice_line_number\": \"\",\n \"product_code_1\": \"\",\n \"product_name\": \"\",\n \"product_code_2\": \"\",\n \"quantity\": \"\",\n \"unit_price\": \"\",\n \"unit_of_measure\": \"\",\n \"net_amount\": \"\",\n \"tax_amount\": \"\",\n \"tax_rate\": \"\",\n \"gross_amount\": \"\",\n \"order_number_1\": \"\",\n \"order_number_2\": \"\",\n \"delivery_date\": \"\",\n \"delivery_note\": \"\",\n \"custom_text_1\": \"\",\n \"custom_text_2\": \"\",\n \"custom_text_3\": \"\",\n \"custom_text_4\": \"\",\n \"custom_text_5\": \"\",\n \"custom_text_6\": \"\",\n \"custom_text_7\": \"\",\n \"custom_text_8\": \"\",\n \"custom_text_9\": \"\",\n \"custom_text_10\": \"\",\n \"custom_text_11\": \"\",\n \"custom_text_12\": \"\",\n \"custom_text_13\": \"\",\n \"custom_text_14\": \"\",\n \"custom_text_15\": \"\",\n \"custom_number_1\": \"\",\n \"custom_number_2\": \"\",\n \"custom_number_3\": \"\",\n \"custom_number_4\": \"\",\n \"custom_number_5\": \"\",\n \"custom_number_6\": \"\",\n \"custom_number_7\": \"\",\n \"custom_number_8\": \"\",\n \"custom_number_9\": \"\",\n \"custom_number_10\": \"\",\n \"custom_date_1\": \"\",\n \"custom_date_2\": \"\",\n \"custom_date_3\": \"\",\n \"custom_date_4\": \"\",\n \"custom_date_5\": \"\",\n \"custom_date_6\": \"\",\n \"custom_date_7\": \"\",\n \"custom_date_8\": \"\",\n \"custom_date_9\": \"\",\n \"custom_date_10\": \"\"\n }\n ],\n \"addresses\": [\n {\n \"address_type\": \"\",\n \"address_name\": \"\",\n \"street\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"\",\n \"country\": \"\"\n },\n {\n \"address_type\": \"\",\n \"address_name\": \"\",\n \"street\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"\",\n \"country\": \"\"\n }\n ],\n \"taxes\": [\n {\n \"tax_name\": \"\",\n \"tax_rate\": \"\",\n \"tax_base_amount\": \"\",\n \"tax_amount\": \"\",\n \"tax_description\": \"\"\n },\n {\n \"tax_name\": \"\",\n \"tax_rate\": \"\",\n \"tax_base_amount\": \"\",\n \"tax_amount\": \"\",\n \"tax_description\": \"\"\n }\n ],\n \"charges\": [\n {\n \"charge_name\": \"\",\n \"charge_amount\": \"\"\n },\n {\n \"charge_name\": \"\",\n \"charge_amount\": \"\"\n }\n ],\n \"discounts\": [\n {\n \"discount_description\": \"\",\n \"discount_rate\": \"\",\n \"discount_amount\": \"\",\n \"discount_due_date\": \"\",\n \"due_date_basis\": \"\",\n \"due_date_period_value\": \"\",\n \"due_date_period_measure\": \"\"\n },\n {\n \"discount_description\": \"\",\n \"discount_rate\": \"\",\n \"discount_amount\": \"\",\n \"discount_due_date\": \"\",\n \"due_date_basis\": \"\",\n \"due_date_period_value\": \"\",\n \"due_date_period_measure\": \"\"\n }\n ]\n },\n \"receiving_inbox\": \"\",\n \"external_identifier\": \"\",\n \"attachments\": [\n {\n \"document_token\": \"\",\n \"type\": \"\"\n },\n {\n \"document_token\": \"\",\n \"type\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "378277d0-d9c0-4d7e-b361-3d391a3ce882", "name": "Invoice imported successfully", "originalRequest": { "url": { "path": [ "v1", "invoice-import" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Optional client-supplied unique key (max 255 chars). Repeating a request with the same Idempotency-Key returns the original invoice_token instead of creating a duplicate. Mappings expire after 24h.", "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"workflow\": \"full_enrichment\",\n \"receiving_inbox\": \"invoices@acme.apreceiving.com\",\n \"external_identifier\": \"ACME-001\",\n \"attachments\": [\n {\n \"filename\": \"invoice.pdf\",\n \"content\": \"JVBERi0xLjQKJeLjz9MKMSAwIG9iago8PC9UeXBlL0NhdGFsb2c+PgplbmRvYmoKJSVFT0Y=\",\n \"content_type\": \"application/pdf\",\n \"type\": \"IMAGE\"\n },\n {\n \"document_token\": \"650e8400-e29b-41d4-a716-446655440001\",\n \"type\": \"ATTACHMENT\"\n }\n ],\n \"invoice\": {\n \"header\": {\n \"invoice_number\": \"INV-2024-001\",\n \"document_type\": \"INVOICE\",\n \"original_invoice_number\": \"ORIG-12345\",\n \"invoice_date\": \"2024-01-15\",\n \"due_date\": \"2024-02-15\",\n \"delivery_date\": \"2024-01-10\",\n \"order_number_1\": \"PO-12345\",\n \"order_number_2\": \"CO-67890\",\n \"contract_number\": \"CONTRACT-2024-001\",\n \"delivery_note\": \"DN-12345\",\n \"reference_number\": \"REF-12345\",\n \"account_number\": \"ACCT-9999\",\n \"net_amount\": 1000,\n \"tax_amount\": 100,\n \"gross_amount\": 1100,\n \"currency_code\": \"USD\",\n \"supplier_name\": \"Acme Corp\",\n \"supplier_tax_id\": \"TAX-123456\",\n \"supplier_contact\": \"John Smith\",\n \"customer_name\": \"Customer LLC\",\n \"customer_tax_id\": \"TAX-789012\",\n \"customer_contact\": \"Jane Doe\",\n \"bank_account\": \"1234567890\",\n \"bank_name\": \"First National Bank\",\n \"payment_method\": \"WIRE\",\n \"payment_terms\": \"Net 30\",\n \"custom_text_1\": \"Cost Center A\",\n \"custom_number_1\": 42,\n \"custom_date_1\": \"2024-01-20\",\n \"ext_reference_1\": \"EXT-REF-1\",\n \"identifier_field_1\": \"ID-1\"\n },\n \"lines\": [\n {\n \"invoice_line_number\": 1,\n \"product_code_1\": \"PROD-001\",\n \"product_name\": \"Widget\",\n \"product_code_2\": \"CUST-PROD-001\",\n \"quantity\": 10,\n \"unit_price\": 25.5,\n \"unit_of_measure\": \"EA\",\n \"net_amount\": 255,\n \"tax_amount\": 25.5,\n \"tax_rate\": 10,\n \"gross_amount\": 280.5,\n \"order_number_1\": \"PO-12345\",\n \"order_number_2\": \"CO-67890\",\n \"delivery_date\": \"2024-01-10\",\n \"delivery_note\": \"DN-12345\",\n \"custom_text_1\": \"Line note A\",\n \"custom_number_1\": 7,\n \"custom_date_1\": \"2024-01-12\"\n }\n ],\n \"addresses\": [\n {\n \"address_type\": \"BILLTO\",\n \"address_name\": \"Headquarters\",\n \"street\": \"123 Main St\",\n \"city\": \"New York\",\n \"state\": \"NY\",\n \"postal_code\": \"10001\",\n \"country\": \"USA\"\n },\n {\n \"address_type\": \"SUPPLIER\",\n \"address_name\": \"Acme HQ\",\n \"street\": \"456 Vendor Rd\",\n \"city\": \"Boston\",\n \"state\": \"MA\",\n \"postal_code\": \"02101\",\n \"country\": \"USA\"\n }\n ],\n \"taxes\": [\n {\n \"tax_name\": \"Sales Tax\",\n \"tax_rate\": 10,\n \"tax_base_amount\": 1000,\n \"tax_amount\": 100,\n \"tax_description\": \"State sales tax\"\n }\n ],\n \"charges\": [\n {\n \"charge_name\": \"Shipping\",\n \"charge_amount\": 15\n }\n ],\n \"discounts\": [\n {\n \"discount_description\": \"2/10 Net 30\",\n \"discount_rate\": 2,\n \"discount_amount\": 20,\n \"discount_due_date\": \"2024-01-25\"\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"data\": {\n \"invoice_token\": \"750e8400-e29b-41d4-a716-446655440002\",\n \"invoice_id\": 12345,\n \"source_document_id\": 67890,\n \"workflow\": \"payment_portal\",\n \"effective_workflow\": \"payment_portal\",\n \"invoice_status\": 100,\n \"source_document_status\": 100,\n \"template_id\": 5,\n \"template_type\": \"global\",\n \"attachments_linked\": 1,\n \"receiving_inbox\": \"invoices@company.apreceiving.com\",\n \"external_identifier\": null,\n \"resolution_path\": \"explicit_inbox\",\n \"receiving_inbox_fallback_used\": false,\n \"pdf_will_be_generated\": false\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b7b5a5e4-3aac-4a17-ac07-ca57d06240eb", "name": "Validation failed or configuration error", "originalRequest": { "url": { "path": [ "v1", "invoice-import" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Optional client-supplied unique key (max 255 chars). Repeating a request with the same Idempotency-Key returns the original invoice_token instead of creating a duplicate. Mappings expire after 24h.", "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"workflow\": \"full_enrichment\",\n \"receiving_inbox\": \"invoices@acme.apreceiving.com\",\n \"external_identifier\": \"ACME-001\",\n \"attachments\": [\n {\n \"filename\": \"invoice.pdf\",\n \"content\": \"JVBERi0xLjQKJeLjz9MKMSAwIG9iago8PC9UeXBlL0NhdGFsb2c+PgplbmRvYmoKJSVFT0Y=\",\n \"content_type\": \"application/pdf\",\n \"type\": \"IMAGE\"\n },\n {\n \"document_token\": \"650e8400-e29b-41d4-a716-446655440001\",\n \"type\": \"ATTACHMENT\"\n }\n ],\n \"invoice\": {\n \"header\": {\n \"invoice_number\": \"INV-2024-001\",\n \"document_type\": \"INVOICE\",\n \"original_invoice_number\": \"ORIG-12345\",\n \"invoice_date\": \"2024-01-15\",\n \"due_date\": \"2024-02-15\",\n \"delivery_date\": \"2024-01-10\",\n \"order_number_1\": \"PO-12345\",\n \"order_number_2\": \"CO-67890\",\n \"contract_number\": \"CONTRACT-2024-001\",\n \"delivery_note\": \"DN-12345\",\n \"reference_number\": \"REF-12345\",\n \"account_number\": \"ACCT-9999\",\n \"net_amount\": 1000,\n \"tax_amount\": 100,\n \"gross_amount\": 1100,\n \"currency_code\": \"USD\",\n \"supplier_name\": \"Acme Corp\",\n \"supplier_tax_id\": \"TAX-123456\",\n \"supplier_contact\": \"John Smith\",\n \"customer_name\": \"Customer LLC\",\n \"customer_tax_id\": \"TAX-789012\",\n \"customer_contact\": \"Jane Doe\",\n \"bank_account\": \"1234567890\",\n \"bank_name\": \"First National Bank\",\n \"payment_method\": \"WIRE\",\n \"payment_terms\": \"Net 30\",\n \"custom_text_1\": \"Cost Center A\",\n \"custom_number_1\": 42,\n \"custom_date_1\": \"2024-01-20\",\n \"ext_reference_1\": \"EXT-REF-1\",\n \"identifier_field_1\": \"ID-1\"\n },\n \"lines\": [\n {\n \"invoice_line_number\": 1,\n \"product_code_1\": \"PROD-001\",\n \"product_name\": \"Widget\",\n \"product_code_2\": \"CUST-PROD-001\",\n \"quantity\": 10,\n \"unit_price\": 25.5,\n \"unit_of_measure\": \"EA\",\n \"net_amount\": 255,\n \"tax_amount\": 25.5,\n \"tax_rate\": 10,\n \"gross_amount\": 280.5,\n \"order_number_1\": \"PO-12345\",\n \"order_number_2\": \"CO-67890\",\n \"delivery_date\": \"2024-01-10\",\n \"delivery_note\": \"DN-12345\",\n \"custom_text_1\": \"Line note A\",\n \"custom_number_1\": 7,\n \"custom_date_1\": \"2024-01-12\"\n }\n ],\n \"addresses\": [\n {\n \"address_type\": \"BILLTO\",\n \"address_name\": \"Headquarters\",\n \"street\": \"123 Main St\",\n \"city\": \"New York\",\n \"state\": \"NY\",\n \"postal_code\": \"10001\",\n \"country\": \"USA\"\n },\n {\n \"address_type\": \"SUPPLIER\",\n \"address_name\": \"Acme HQ\",\n \"street\": \"456 Vendor Rd\",\n \"city\": \"Boston\",\n \"state\": \"MA\",\n \"postal_code\": \"02101\",\n \"country\": \"USA\"\n }\n ],\n \"taxes\": [\n {\n \"tax_name\": \"Sales Tax\",\n \"tax_rate\": 10,\n \"tax_base_amount\": 1000,\n \"tax_amount\": 100,\n \"tax_description\": \"State sales tax\"\n }\n ],\n \"charges\": [\n {\n \"charge_name\": \"Shipping\",\n \"charge_amount\": 15\n }\n ],\n \"discounts\": [\n {\n \"discount_description\": \"2/10 Net 30\",\n \"discount_rate\": 2,\n \"discount_amount\": 20,\n \"discount_due_date\": \"2024-01-25\"\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"errors\": [\n \"string\",\n \"string\"\n ],\n \"message\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f8b9cac4-c295-478e-9570-2e32692bd3a0", "name": "Unauthorized - invalid API key", "originalRequest": { "url": { "path": [ "v1", "invoice-import" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Optional client-supplied unique key (max 255 chars). Repeating a request with the same Idempotency-Key returns the original invoice_token instead of creating a duplicate. Mappings expire after 24h.", "key": "Idempotency-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"workflow\": \"full_enrichment\",\n \"receiving_inbox\": \"invoices@acme.apreceiving.com\",\n \"external_identifier\": \"ACME-001\",\n \"attachments\": [\n {\n \"filename\": \"invoice.pdf\",\n \"content\": \"JVBERi0xLjQKJeLjz9MKMSAwIG9iago8PC9UeXBlL0NhdGFsb2c+PgplbmRvYmoKJSVFT0Y=\",\n \"content_type\": \"application/pdf\",\n \"type\": \"IMAGE\"\n },\n {\n \"document_token\": \"650e8400-e29b-41d4-a716-446655440001\",\n \"type\": \"ATTACHMENT\"\n }\n ],\n \"invoice\": {\n \"header\": {\n \"invoice_number\": \"INV-2024-001\",\n \"document_type\": \"INVOICE\",\n \"original_invoice_number\": \"ORIG-12345\",\n \"invoice_date\": \"2024-01-15\",\n \"due_date\": \"2024-02-15\",\n \"delivery_date\": \"2024-01-10\",\n \"order_number_1\": \"PO-12345\",\n \"order_number_2\": \"CO-67890\",\n \"contract_number\": \"CONTRACT-2024-001\",\n \"delivery_note\": \"DN-12345\",\n \"reference_number\": \"REF-12345\",\n \"account_number\": \"ACCT-9999\",\n \"net_amount\": 1000,\n \"tax_amount\": 100,\n \"gross_amount\": 1100,\n \"currency_code\": \"USD\",\n \"supplier_name\": \"Acme Corp\",\n \"supplier_tax_id\": \"TAX-123456\",\n \"supplier_contact\": \"John Smith\",\n \"customer_name\": \"Customer LLC\",\n \"customer_tax_id\": \"TAX-789012\",\n \"customer_contact\": \"Jane Doe\",\n \"bank_account\": \"1234567890\",\n \"bank_name\": \"First National Bank\",\n \"payment_method\": \"WIRE\",\n \"payment_terms\": \"Net 30\",\n \"custom_text_1\": \"Cost Center A\",\n \"custom_number_1\": 42,\n \"custom_date_1\": \"2024-01-20\",\n \"ext_reference_1\": \"EXT-REF-1\",\n \"identifier_field_1\": \"ID-1\"\n },\n \"lines\": [\n {\n \"invoice_line_number\": 1,\n \"product_code_1\": \"PROD-001\",\n \"product_name\": \"Widget\",\n \"product_code_2\": \"CUST-PROD-001\",\n \"quantity\": 10,\n \"unit_price\": 25.5,\n \"unit_of_measure\": \"EA\",\n \"net_amount\": 255,\n \"tax_amount\": 25.5,\n \"tax_rate\": 10,\n \"gross_amount\": 280.5,\n \"order_number_1\": \"PO-12345\",\n \"order_number_2\": \"CO-67890\",\n \"delivery_date\": \"2024-01-10\",\n \"delivery_note\": \"DN-12345\",\n \"custom_text_1\": \"Line note A\",\n \"custom_number_1\": 7,\n \"custom_date_1\": \"2024-01-12\"\n }\n ],\n \"addresses\": [\n {\n \"address_type\": \"BILLTO\",\n \"address_name\": \"Headquarters\",\n \"street\": \"123 Main St\",\n \"city\": \"New York\",\n \"state\": \"NY\",\n \"postal_code\": \"10001\",\n \"country\": \"USA\"\n },\n {\n \"address_type\": \"SUPPLIER\",\n \"address_name\": \"Acme HQ\",\n \"street\": \"456 Vendor Rd\",\n \"city\": \"Boston\",\n \"state\": \"MA\",\n \"postal_code\": \"02101\",\n \"country\": \"USA\"\n }\n ],\n \"taxes\": [\n {\n \"tax_name\": \"Sales Tax\",\n \"tax_rate\": 10,\n \"tax_base_amount\": 1000,\n \"tax_amount\": 100,\n \"tax_description\": \"State sales tax\"\n }\n ],\n \"charges\": [\n {\n \"charge_name\": \"Shipping\",\n \"charge_amount\": 15\n }\n ],\n \"discounts\": [\n {\n \"discount_description\": \"2/10 Net 30\",\n \"discount_rate\": 2,\n \"discount_amount\": 20,\n \"discount_due_date\": \"2024-01-25\"\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "5cf70aaf-3222-4d95-bbcb-42d847db240e", "name": "Internal server error", "originalRequest": { "url": { "path": [ "v1", "invoice-import" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Optional client-supplied unique key (max 255 chars). Repeating a request with the same Idempotency-Key returns the original invoice_token instead of creating a duplicate. Mappings expire after 24h.", "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"workflow\": \"full_enrichment\",\n \"receiving_inbox\": \"invoices@acme.apreceiving.com\",\n \"external_identifier\": \"ACME-001\",\n \"attachments\": [\n {\n \"filename\": \"invoice.pdf\",\n \"content\": \"JVBERi0xLjQKJeLjz9MKMSAwIG9iago8PC9UeXBlL0NhdGFsb2c+PgplbmRvYmoKJSVFT0Y=\",\n \"content_type\": \"application/pdf\",\n \"type\": \"IMAGE\"\n },\n {\n \"document_token\": \"650e8400-e29b-41d4-a716-446655440001\",\n \"type\": \"ATTACHMENT\"\n }\n ],\n \"invoice\": {\n \"header\": {\n \"invoice_number\": \"INV-2024-001\",\n \"document_type\": \"INVOICE\",\n \"original_invoice_number\": \"ORIG-12345\",\n \"invoice_date\": \"2024-01-15\",\n \"due_date\": \"2024-02-15\",\n \"delivery_date\": \"2024-01-10\",\n \"order_number_1\": \"PO-12345\",\n \"order_number_2\": \"CO-67890\",\n \"contract_number\": \"CONTRACT-2024-001\",\n \"delivery_note\": \"DN-12345\",\n \"reference_number\": \"REF-12345\",\n \"account_number\": \"ACCT-9999\",\n \"net_amount\": 1000,\n \"tax_amount\": 100,\n \"gross_amount\": 1100,\n \"currency_code\": \"USD\",\n \"supplier_name\": \"Acme Corp\",\n \"supplier_tax_id\": \"TAX-123456\",\n \"supplier_contact\": \"John Smith\",\n \"customer_name\": \"Customer LLC\",\n \"customer_tax_id\": \"TAX-789012\",\n \"customer_contact\": \"Jane Doe\",\n \"bank_account\": \"1234567890\",\n \"bank_name\": \"First National Bank\",\n \"payment_method\": \"WIRE\",\n \"payment_terms\": \"Net 30\",\n \"custom_text_1\": \"Cost Center A\",\n \"custom_number_1\": 42,\n \"custom_date_1\": \"2024-01-20\",\n \"ext_reference_1\": \"EXT-REF-1\",\n \"identifier_field_1\": \"ID-1\"\n },\n \"lines\": [\n {\n \"invoice_line_number\": 1,\n \"product_code_1\": \"PROD-001\",\n \"product_name\": \"Widget\",\n \"product_code_2\": \"CUST-PROD-001\",\n \"quantity\": 10,\n \"unit_price\": 25.5,\n \"unit_of_measure\": \"EA\",\n \"net_amount\": 255,\n \"tax_amount\": 25.5,\n \"tax_rate\": 10,\n \"gross_amount\": 280.5,\n \"order_number_1\": \"PO-12345\",\n \"order_number_2\": \"CO-67890\",\n \"delivery_date\": \"2024-01-10\",\n \"delivery_note\": \"DN-12345\",\n \"custom_text_1\": \"Line note A\",\n \"custom_number_1\": 7,\n \"custom_date_1\": \"2024-01-12\"\n }\n ],\n \"addresses\": [\n {\n \"address_type\": \"BILLTO\",\n \"address_name\": \"Headquarters\",\n \"street\": \"123 Main St\",\n \"city\": \"New York\",\n \"state\": \"NY\",\n \"postal_code\": \"10001\",\n \"country\": \"USA\"\n },\n {\n \"address_type\": \"SUPPLIER\",\n \"address_name\": \"Acme HQ\",\n \"street\": \"456 Vendor Rd\",\n \"city\": \"Boston\",\n \"state\": \"MA\",\n \"postal_code\": \"02101\",\n \"country\": \"USA\"\n }\n ],\n \"taxes\": [\n {\n \"tax_name\": \"Sales Tax\",\n \"tax_rate\": 10,\n \"tax_base_amount\": 1000,\n \"tax_amount\": 100,\n \"tax_description\": \"State sales tax\"\n }\n ],\n \"charges\": [\n {\n \"charge_name\": \"Shipping\",\n \"charge_amount\": 15\n }\n ],\n \"discounts\": [\n {\n \"discount_description\": \"2/10 Net 30\",\n \"discount_rate\": 2,\n \"discount_amount\": 20,\n \"discount_due_date\": \"2024-01-25\"\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"string\",\n \"message\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "7d7f15e8-3832-4e1c-b28d-bc8f65370ba2", "name": "Invoice Lifecycle", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "0015c335-5615-4d04-9738-3f190671ed9d", "name": "Cross-invoice lifecycle delta poll", "request": { "name": "Cross-invoice lifecycle delta poll", "description": { "content": "\nReturns lifecycle messages recorded since a given timestamp, scoped to one or\nmore `ext_reference_N` filters.\n\n**When to use this**: pulling lifecycle events for many invoices at once\n(typical case: a connector polling every N minutes for \"what's changed\").\nFor a single known invoice, use `GET /invoices/{token}/lifecycle-messages`.\n\n**Watermark**: messages are ordered and filtered by `recorded_at` (when\nNuntiq learned of the event), NOT `occurred_at`. This guarantees\nback-dated events that arrive after a previous poll are still picked up\nby the next poll.\n\n**ext_reference filtering**: case-insensitive **equality** (`LOWER(col) = LOWER($)`).\nWildcards are NOT interpreted — `%` and `_` are matched literally.\n\n**Pagination**: cursor-based. The response includes `next_cursor` (or\n`null` on the final page); pass it back as the `cursor` query param to\nfetch the next page. The cursor is stable across concurrent inserts so you\nwill not skip rows that arrive mid-poll.\n\n**Required**: `since`, `tz`, and at least one non-empty `ext_reference_N`.\n ", "type": "text/plain" }, "url": { "path": [ "v1", "invoice-lifecycle-messages" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "since", "value": "", "description": "(Required) ISO-8601 timestamp. If naked (e.g. `2026-04-25T08:00:00`), interpreted in `tz`. If it carries an explicit Z or +HH:MM offset, that offset is honored as-is." }, { "disabled": false, "key": "tz", "value": "", "description": "(Required) IANA zone name. Always required so the API can fail fast on typos like `CET` or `GMT+1`." }, { "disabled": true, "key": "ext_reference_1", "value": "", "description": "Filter on invoices.ext_reference_1, case-insensitive equality." }, { "disabled": true, "key": "ext_reference_2", "value": "", "description": "Filter on invoices.ext_reference_2, case-insensitive equality." }, { "disabled": true, "key": "ext_reference_3", "value": "", "description": "Filter on invoices.ext_reference_3, case-insensitive equality." }, { "disabled": true, "key": "ext_reference_4", "value": "", "description": "Filter on invoices.ext_reference_4, case-insensitive equality." }, { "disabled": true, "key": "ext_reference_5", "value": "", "description": "Filter on invoices.ext_reference_5, case-insensitive equality." }, { "disabled": true, "key": "tier", "value": "", "description": "Restrict to a single lifecycle tier. 1 = INTAKE, 2 = BUYER_SIDE, 3 = FINANCIAL. Default `all`." }, { "disabled": true, "key": "include_internal_notes", "value": "", "description": "`true` to include `note_internal` in the response. Requires the caller to hold the `LIFECYCLE_READ_INTERNAL` permission; otherwise the field is silently dropped." }, { "disabled": true, "key": "limit", "value": "500", "description": "Page size. Default 500, max 5000." }, { "disabled": true, "key": "cursor", "value": "", "description": "Opaque token from a prior response's `next_cursor`. Omit on the first request." } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "83a1b8c1-81c4-410e-b9ff-ae624a40e287", "name": "Lifecycle messages page", "originalRequest": { "url": { "path": [ "v1", "invoice-lifecycle-messages" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "since", "value": "2026-04-25T08:00:00" }, { "key": "tz", "value": "Europe/Amsterdam" }, { "key": "ext_reference_1", "value": "" }, { "key": "ext_reference_2", "value": "" }, { "key": "ext_reference_3", "value": "" }, { "key": "ext_reference_4", "value": "" }, { "key": "ext_reference_5", "value": "" }, { "key": "tier", "value": "" }, { "key": "include_internal_notes", "value": "" }, { "key": "limit", "value": "500" }, { "key": "cursor", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"since_utc\": \"1957-11-30T10:55:41.068Z\",\n \"tz\": \"string\",\n \"filters\": {\n \"ext_reference_1\": \"string\",\n \"ext_reference_2\": \"string\",\n \"ext_reference_3\": \"string\",\n \"ext_reference_4\": \"string\",\n \"ext_reference_5\": \"string\"\n },\n \"tier\": \"all\",\n \"messages\": [\n {\n \"id\": 6960,\n \"invoice_id\": 3288,\n \"invoice_token\": \"bfe5302e-6e2e-2d4b-79d1-e960be62aa32\",\n \"ext_reference_1\": \"string\",\n \"ext_reference_2\": \"string\",\n \"ext_reference_3\": \"string\",\n \"ext_reference_4\": \"string\",\n \"ext_reference_5\": \"string\",\n \"code\": \"string\",\n \"source\": \"EXTERNAL_API\",\n \"actor_type\": \"string\",\n \"actor_id\": \"string\",\n \"actor_display_name\": \"string\",\n \"occurred_at\": \"2020-12-10T05:30:05.396Z\",\n \"recorded_at\": \"1959-06-06T06:38:19.617Z\",\n \"clarification_code\": \"string\",\n \"note_internal\": \"string\",\n \"note_supplier\": \"string\",\n \"reference_type\": \"CREDIT_NOTE\",\n \"reference_value\": \"string\"\n },\n {\n \"id\": 4067,\n \"invoice_id\": 610,\n \"invoice_token\": \"8370ff4e-e83c-4a76-dc4d-6cc929baef2d\",\n \"ext_reference_1\": \"string\",\n \"ext_reference_2\": \"string\",\n \"ext_reference_3\": \"string\",\n \"ext_reference_4\": \"string\",\n \"ext_reference_5\": \"string\",\n \"code\": \"string\",\n \"source\": \"NUNTIQ\",\n \"actor_type\": \"string\",\n \"actor_id\": \"string\",\n \"actor_display_name\": \"string\",\n \"occurred_at\": \"1949-01-14T15:45:26.877Z\",\n \"recorded_at\": \"2023-03-13T13:44:39.594Z\",\n \"clarification_code\": \"string\",\n \"note_internal\": \"string\",\n \"note_supplier\": \"string\",\n \"reference_type\": \"CREDIT_NOTE\",\n \"reference_value\": \"string\"\n }\n ],\n \"next_cursor\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e6fd1211-b1cc-4a6e-b90f-143c584165a2", "name": "Invalid request — see error code", "originalRequest": { "url": { "path": [ "v1", "invoice-lifecycle-messages" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "since", "value": "2026-04-25T08:00:00" }, { "key": "tz", "value": "Europe/Amsterdam" }, { "key": "ext_reference_1", "value": "" }, { "key": "ext_reference_2", "value": "" }, { "key": "ext_reference_3", "value": "" }, { "key": "ext_reference_4", "value": "" }, { "key": "ext_reference_5", "value": "" }, { "key": "tier", "value": "" }, { "key": "include_internal_notes", "value": "" }, { "key": "limit", "value": "500" }, { "key": "cursor", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"MISSING_REQUIRED_PARAM\",\n \"message\": \"`since` is required (ISO-8601 timestamp)\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a0d58ac1-4a33-4067-8c83-c35e853c2000", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1", "invoice-lifecycle-messages" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "since", "value": "2026-04-25T08:00:00" }, { "key": "tz", "value": "Europe/Amsterdam" }, { "key": "ext_reference_1", "value": "" }, { "key": "ext_reference_2", "value": "" }, { "key": "ext_reference_3", "value": "" }, { "key": "ext_reference_4", "value": "" }, { "key": "ext_reference_5", "value": "" }, { "key": "tier", "value": "" }, { "key": "include_internal_notes", "value": "" }, { "key": "limit", "value": "500" }, { "key": "cursor", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"string\",\n \"code\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "34f1287c-6a32-48e4-abd9-67045e763888", "name": "Forbidden — missing READ_DOCS or READ_DATA", "originalRequest": { "url": { "path": [ "v1", "invoice-lifecycle-messages" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "since", "value": "2026-04-25T08:00:00" }, { "key": "tz", "value": "Europe/Amsterdam" }, { "key": "ext_reference_1", "value": "" }, { "key": "ext_reference_2", "value": "" }, { "key": "ext_reference_3", "value": "" }, { "key": "ext_reference_4", "value": "" }, { "key": "ext_reference_5", "value": "" }, { "key": "tier", "value": "" }, { "key": "include_internal_notes", "value": "" }, { "key": "limit", "value": "500" }, { "key": "cursor", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"string\",\n \"code\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "89bdaaa7-95a0-4c5f-b135-5e367093e38f", "name": "Internal server error", "originalRequest": { "url": { "path": [ "v1", "invoice-lifecycle-messages" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "since", "value": "2026-04-25T08:00:00" }, { "key": "tz", "value": "Europe/Amsterdam" }, { "key": "ext_reference_1", "value": "" }, { "key": "ext_reference_2", "value": "" }, { "key": "ext_reference_3", "value": "" }, { "key": "ext_reference_4", "value": "" }, { "key": "ext_reference_5", "value": "" }, { "key": "tier", "value": "" }, { "key": "include_internal_notes", "value": "" }, { "key": "limit", "value": "500" }, { "key": "cursor", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"string\",\n \"code\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "7e98b2e6-bca0-48fd-b070-5c219ccefba4", "name": "Organization", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "89497d83-30bd-4e4f-858b-e63c9265ff57", "name": "List organization units", "request": { "name": "List organization units", "description": { "content": "Returns a paginated list of organization units including identifiers and addresses. Only non-deleted records are returned.", "type": "text/plain" }, "url": { "path": [ "v1", "organization" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "key": "page", "value": "1", "description": "Page number for pagination" }, { "disabled": true, "key": "limit", "value": "1000", "description": "Number of records per page (max 1000)" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "64201d8d-2392-4baf-b042-33e7726a21eb", "name": "List of organization units", "originalRequest": { "url": { "path": [ "v1", "organization" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "limit", "value": "1000" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"count\": 7201,\n \"page\": 9960,\n \"totalPages\": 6079,\n \"organization_units\": [\n {\n \"name\": \"string\",\n \"code\": \"string\",\n \"organization_type\": 760,\n \"parent_id\": \"string\",\n \"active\": false,\n \"active_from\": \"1983-01-04T23:22:31.940Z\",\n \"active_to\": \"2007-06-04T22:48:14.964Z\",\n \"default_currency\": \"string\",\n \"custom_field_1\": \"string\",\n \"custom_field_2\": \"string\",\n \"custom_field_3\": \"string\",\n \"custom_field_4\": \"string\",\n \"custom_field_5\": \"string\",\n \"custom_field_6\": \"string\",\n \"custom_field_7\": \"string\",\n \"custom_field_8\": \"string\",\n \"custom_field_9\": \"string\",\n \"custom_field_10\": \"string\",\n \"custom_field_11\": \"string\",\n \"custom_field_12\": \"string\",\n \"custom_field_13\": \"string\",\n \"custom_field_14\": \"string\",\n \"custom_field_15\": \"string\",\n \"created_at\": \"2008-03-16T16:37:17.922Z\",\n \"updated_at\": \"1995-08-30T07:56:20.252Z\",\n \"identifiers\": [\n {\n \"identifier_label\": \"string\",\n \"identifier_value\": \"string\",\n \"identifier_type\": \"string\",\n \"created_at\": \"1975-01-23T01:19:27.868Z\",\n \"updated_at\": \"2018-08-15T09:01:57.653Z\"\n },\n {\n \"identifier_label\": \"string\",\n \"identifier_value\": \"string\",\n \"identifier_type\": \"string\",\n \"created_at\": \"1960-05-28T12:56:25.449Z\",\n \"updated_at\": \"2022-10-10T04:39:54.919Z\"\n }\n ],\n \"addresses\": [\n {\n \"name\": \"string\",\n \"street\": \"string\",\n \"city\": \"string\",\n \"state\": \"string\",\n \"postal_code\": \"string\",\n \"country_code\": \"string\",\n \"custom_field_1\": \"string\",\n \"custom_field_2\": \"string\",\n \"custom_field_3\": \"string\",\n \"custom_field_4\": \"string\",\n \"custom_field_5\": \"string\",\n \"created_at\": \"2000-03-06T13:47:58.020Z\",\n \"updated_at\": \"2000-11-27T21:10:41.964Z\"\n },\n {\n \"name\": \"string\",\n \"street\": \"string\",\n \"city\": \"string\",\n \"state\": \"string\",\n \"postal_code\": \"string\",\n \"country_code\": \"string\",\n \"custom_field_1\": \"string\",\n \"custom_field_2\": \"string\",\n \"custom_field_3\": \"string\",\n \"custom_field_4\": \"string\",\n \"custom_field_5\": \"string\",\n \"created_at\": \"2001-03-16T22:24:23.810Z\",\n \"updated_at\": \"2012-04-23T23:14:51.665Z\"\n }\n ]\n },\n {\n \"name\": \"string\",\n \"code\": \"string\",\n \"organization_type\": 6160,\n \"parent_id\": \"string\",\n \"active\": false,\n \"active_from\": \"1992-05-13T18:39:25.596Z\",\n \"active_to\": \"2013-08-02T02:54:34.641Z\",\n \"default_currency\": \"string\",\n \"custom_field_1\": \"string\",\n \"custom_field_2\": \"string\",\n \"custom_field_3\": \"string\",\n \"custom_field_4\": \"string\",\n \"custom_field_5\": \"string\",\n \"custom_field_6\": \"string\",\n \"custom_field_7\": \"string\",\n \"custom_field_8\": \"string\",\n \"custom_field_9\": \"string\",\n \"custom_field_10\": \"string\",\n \"custom_field_11\": \"string\",\n \"custom_field_12\": \"string\",\n \"custom_field_13\": \"string\",\n \"custom_field_14\": \"string\",\n \"custom_field_15\": \"string\",\n \"created_at\": \"1968-12-30T15:27:34.977Z\",\n \"updated_at\": \"1979-05-30T10:32:24.266Z\",\n \"identifiers\": [\n {\n \"identifier_label\": \"string\",\n \"identifier_value\": \"string\",\n \"identifier_type\": \"string\",\n \"created_at\": \"2014-09-05T15:13:20.504Z\",\n \"updated_at\": \"1976-11-29T21:36:43.412Z\"\n },\n {\n \"identifier_label\": \"string\",\n \"identifier_value\": \"string\",\n \"identifier_type\": \"string\",\n \"created_at\": \"2003-08-31T12:03:47.366Z\",\n \"updated_at\": \"1958-07-16T14:21:57.917Z\"\n }\n ],\n \"addresses\": [\n {\n \"name\": \"string\",\n \"street\": \"string\",\n \"city\": \"string\",\n \"state\": \"string\",\n \"postal_code\": \"string\",\n \"country_code\": \"string\",\n \"custom_field_1\": \"string\",\n \"custom_field_2\": \"string\",\n \"custom_field_3\": \"string\",\n \"custom_field_4\": \"string\",\n \"custom_field_5\": \"string\",\n \"created_at\": \"2003-12-03T11:37:15.329Z\",\n \"updated_at\": \"1967-07-06T16:28:55.658Z\"\n },\n {\n \"name\": \"string\",\n \"street\": \"string\",\n \"city\": \"string\",\n \"state\": \"string\",\n \"postal_code\": \"string\",\n \"country_code\": \"string\",\n \"custom_field_1\": \"string\",\n \"custom_field_2\": \"string\",\n \"custom_field_3\": \"string\",\n \"custom_field_4\": \"string\",\n \"custom_field_5\": \"string\",\n \"created_at\": \"1990-12-11T18:13:23.098Z\",\n \"updated_at\": \"1951-08-26T01:52:23.527Z\"\n }\n ]\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8adc3089-06b6-421b-9445-38beb6942214", "name": "Unauthorized - invalid or missing API key", "originalRequest": { "url": { "path": [ "v1", "organization" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "limit", "value": "1000" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"Unauthorized\",\n \"message\": \"API key is required\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fe00b28f-dde3-489b-b9aa-65c77bfec3d0", "name": "Forbidden - insufficient permissions", "originalRequest": { "url": { "path": [ "v1", "organization" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "limit", "value": "1000" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"Forbidden\",\n \"message\": \"API user does not have required permissions: READ_ORG, READ_DATA\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b68e2e6a-95ce-49b7-94d0-87444a36caa4", "name": "Internal server error", "originalRequest": { "url": { "path": [ "v1", "organization" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "limit", "value": "1000" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"Internal server error\",\n \"message\": \"Database query failed\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "87dd68a0-b9e1-44af-bb00-ca6f228855a7", "name": "Upsert organization units", "request": { "name": "Upsert organization units", "description": { "content": "\nImport or update organization units with identifiers and addresses. Supports both incremental updates and full data replacement.\n\n**Upsert Key**: code (`ON CONFLICT` target on the organization_unit table)\n\n**full_load Behavior**:\n- **false** (default): Incremental upsert — updates existing records (matched by code), inserts new ones\n- **true**: Full replacement — deletes ALL existing organization units for the customer, then inserts new data\n\n**Required Fields**: code, name, organization_type\n ", "type": "text/plain" }, "url": { "path": [ "v1", "organization" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "key": "full_load", "value": "false", "description": "If true, clears all existing organization units before inserting new data" } ], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "[\n {\n \"name\": \"\",\n \"code\": \"\",\n \"organization_type\": \"\",\n \"parent_id\": \"\",\n \"active\": \"\",\n \"active_from\": \"\",\n \"active_to\": \"\",\n \"default_currency\": \"\",\n \"custom_field_1\": \"\",\n \"custom_field_2\": \"\",\n \"custom_field_3\": \"\",\n \"custom_field_4\": \"\",\n \"custom_field_5\": \"\",\n \"custom_field_6\": \"\",\n \"custom_field_7\": \"\",\n \"custom_field_8\": \"\",\n \"custom_field_9\": \"\",\n \"custom_field_10\": \"\",\n \"custom_field_11\": \"\",\n \"custom_field_12\": \"\",\n \"custom_field_13\": \"\",\n \"custom_field_14\": \"\",\n \"custom_field_15\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"identifiers\": [\n {\n \"identifier_label\": \"\",\n \"identifier_value\": \"\",\n \"identifier_type\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n },\n {\n \"identifier_label\": \"\",\n \"identifier_value\": \"\",\n \"identifier_type\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n ],\n \"addresses\": [\n {\n \"name\": \"\",\n \"street\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"\",\n \"country_code\": \"\",\n \"custom_field_1\": \"\",\n \"custom_field_2\": \"\",\n \"custom_field_3\": \"\",\n \"custom_field_4\": \"\",\n \"custom_field_5\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n },\n {\n \"name\": \"\",\n \"street\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"\",\n \"country_code\": \"\",\n \"custom_field_1\": \"\",\n \"custom_field_2\": \"\",\n \"custom_field_3\": \"\",\n \"custom_field_4\": \"\",\n \"custom_field_5\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n ]\n },\n {\n \"name\": \"\",\n \"code\": \"\",\n \"organization_type\": \"\",\n \"parent_id\": \"\",\n \"active\": \"\",\n \"active_from\": \"\",\n \"active_to\": \"\",\n \"default_currency\": \"\",\n \"custom_field_1\": \"\",\n \"custom_field_2\": \"\",\n \"custom_field_3\": \"\",\n \"custom_field_4\": \"\",\n \"custom_field_5\": \"\",\n \"custom_field_6\": \"\",\n \"custom_field_7\": \"\",\n \"custom_field_8\": \"\",\n \"custom_field_9\": \"\",\n \"custom_field_10\": \"\",\n \"custom_field_11\": \"\",\n \"custom_field_12\": \"\",\n \"custom_field_13\": \"\",\n \"custom_field_14\": \"\",\n \"custom_field_15\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"identifiers\": [\n {\n \"identifier_label\": \"\",\n \"identifier_value\": \"\",\n \"identifier_type\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n },\n {\n \"identifier_label\": \"\",\n \"identifier_value\": \"\",\n \"identifier_type\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n ],\n \"addresses\": [\n {\n \"name\": \"\",\n \"street\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"\",\n \"country_code\": \"\",\n \"custom_field_1\": \"\",\n \"custom_field_2\": \"\",\n \"custom_field_3\": \"\",\n \"custom_field_4\": \"\",\n \"custom_field_5\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n },\n {\n \"name\": \"\",\n \"street\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"\",\n \"country_code\": \"\",\n \"custom_field_1\": \"\",\n \"custom_field_2\": \"\",\n \"custom_field_3\": \"\",\n \"custom_field_4\": \"\",\n \"custom_field_5\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n ]\n }\n]", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "d5e83a1a-2135-4d20-a241-d4c74c26f1af", "name": "Import result", "originalRequest": { "url": { "path": [ "v1", "organization" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "full_load", "value": "false" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "[\n {\n \"name\": \"\",\n \"code\": \"\",\n \"organization_type\": \"\",\n \"parent_id\": \"\",\n \"active\": \"\",\n \"active_from\": \"\",\n \"active_to\": \"\",\n \"default_currency\": \"\",\n \"custom_field_1\": \"\",\n \"custom_field_2\": \"\",\n \"custom_field_3\": \"\",\n \"custom_field_4\": \"\",\n \"custom_field_5\": \"\",\n \"custom_field_6\": \"\",\n \"custom_field_7\": \"\",\n \"custom_field_8\": \"\",\n \"custom_field_9\": \"\",\n \"custom_field_10\": \"\",\n \"custom_field_11\": \"\",\n \"custom_field_12\": \"\",\n \"custom_field_13\": \"\",\n \"custom_field_14\": \"\",\n \"custom_field_15\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"identifiers\": [\n {\n \"identifier_label\": \"\",\n \"identifier_value\": \"\",\n \"identifier_type\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n },\n {\n \"identifier_label\": \"\",\n \"identifier_value\": \"\",\n \"identifier_type\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n ],\n \"addresses\": [\n {\n \"name\": \"\",\n \"street\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"\",\n \"country_code\": \"\",\n \"custom_field_1\": \"\",\n \"custom_field_2\": \"\",\n \"custom_field_3\": \"\",\n \"custom_field_4\": \"\",\n \"custom_field_5\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n },\n {\n \"name\": \"\",\n \"street\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"\",\n \"country_code\": \"\",\n \"custom_field_1\": \"\",\n \"custom_field_2\": \"\",\n \"custom_field_3\": \"\",\n \"custom_field_4\": \"\",\n \"custom_field_5\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n ]\n },\n {\n \"name\": \"\",\n \"code\": \"\",\n \"organization_type\": \"\",\n \"parent_id\": \"\",\n \"active\": \"\",\n \"active_from\": \"\",\n \"active_to\": \"\",\n \"default_currency\": \"\",\n \"custom_field_1\": \"\",\n \"custom_field_2\": \"\",\n \"custom_field_3\": \"\",\n \"custom_field_4\": \"\",\n \"custom_field_5\": \"\",\n \"custom_field_6\": \"\",\n \"custom_field_7\": \"\",\n \"custom_field_8\": \"\",\n \"custom_field_9\": \"\",\n \"custom_field_10\": \"\",\n \"custom_field_11\": \"\",\n \"custom_field_12\": \"\",\n \"custom_field_13\": \"\",\n \"custom_field_14\": \"\",\n \"custom_field_15\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"identifiers\": [\n {\n \"identifier_label\": \"\",\n \"identifier_value\": \"\",\n \"identifier_type\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n },\n {\n \"identifier_label\": \"\",\n \"identifier_value\": \"\",\n \"identifier_type\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n ],\n \"addresses\": [\n {\n \"name\": \"\",\n \"street\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"\",\n \"country_code\": \"\",\n \"custom_field_1\": \"\",\n \"custom_field_2\": \"\",\n \"custom_field_3\": \"\",\n \"custom_field_4\": \"\",\n \"custom_field_5\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n },\n {\n \"name\": \"\",\n \"street\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"\",\n \"country_code\": \"\",\n \"custom_field_1\": \"\",\n \"custom_field_2\": \"\",\n \"custom_field_3\": \"\",\n \"custom_field_4\": \"\",\n \"custom_field_5\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n ]\n }\n]", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Organization units inserted/updated successfully\",\n \"unitsInserted\": 12\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4223fe0f-2d62-4f20-92af-1405127352f0", "name": "Bad request - validation error", "originalRequest": { "url": { "path": [ "v1", "organization" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "full_load", "value": "false" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "[\n {\n \"name\": \"\",\n \"code\": \"\",\n \"organization_type\": \"\",\n \"parent_id\": \"\",\n \"active\": \"\",\n \"active_from\": \"\",\n \"active_to\": \"\",\n \"default_currency\": \"\",\n \"custom_field_1\": \"\",\n \"custom_field_2\": \"\",\n \"custom_field_3\": \"\",\n \"custom_field_4\": \"\",\n \"custom_field_5\": \"\",\n \"custom_field_6\": \"\",\n \"custom_field_7\": \"\",\n \"custom_field_8\": \"\",\n \"custom_field_9\": \"\",\n \"custom_field_10\": \"\",\n \"custom_field_11\": \"\",\n \"custom_field_12\": \"\",\n \"custom_field_13\": \"\",\n \"custom_field_14\": \"\",\n \"custom_field_15\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"identifiers\": [\n {\n \"identifier_label\": \"\",\n \"identifier_value\": \"\",\n \"identifier_type\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n },\n {\n \"identifier_label\": \"\",\n \"identifier_value\": \"\",\n \"identifier_type\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n ],\n \"addresses\": [\n {\n \"name\": \"\",\n \"street\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"\",\n \"country_code\": \"\",\n \"custom_field_1\": \"\",\n \"custom_field_2\": \"\",\n \"custom_field_3\": \"\",\n \"custom_field_4\": \"\",\n \"custom_field_5\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n },\n {\n \"name\": \"\",\n \"street\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"\",\n \"country_code\": \"\",\n \"custom_field_1\": \"\",\n \"custom_field_2\": \"\",\n \"custom_field_3\": \"\",\n \"custom_field_4\": \"\",\n \"custom_field_5\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n ]\n },\n {\n \"name\": \"\",\n \"code\": \"\",\n \"organization_type\": \"\",\n \"parent_id\": \"\",\n \"active\": \"\",\n \"active_from\": \"\",\n \"active_to\": \"\",\n \"default_currency\": \"\",\n \"custom_field_1\": \"\",\n \"custom_field_2\": \"\",\n \"custom_field_3\": \"\",\n \"custom_field_4\": \"\",\n \"custom_field_5\": \"\",\n \"custom_field_6\": \"\",\n \"custom_field_7\": \"\",\n \"custom_field_8\": \"\",\n \"custom_field_9\": \"\",\n \"custom_field_10\": \"\",\n \"custom_field_11\": \"\",\n \"custom_field_12\": \"\",\n \"custom_field_13\": \"\",\n \"custom_field_14\": \"\",\n \"custom_field_15\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"identifiers\": [\n {\n \"identifier_label\": \"\",\n \"identifier_value\": \"\",\n \"identifier_type\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n },\n {\n \"identifier_label\": \"\",\n \"identifier_value\": \"\",\n \"identifier_type\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n ],\n \"addresses\": [\n {\n \"name\": \"\",\n \"street\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"\",\n \"country_code\": \"\",\n \"custom_field_1\": \"\",\n \"custom_field_2\": \"\",\n \"custom_field_3\": \"\",\n \"custom_field_4\": \"\",\n \"custom_field_5\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n },\n {\n \"name\": \"\",\n \"street\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"\",\n \"country_code\": \"\",\n \"custom_field_1\": \"\",\n \"custom_field_2\": \"\",\n \"custom_field_3\": \"\",\n \"custom_field_4\": \"\",\n \"custom_field_5\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n ]\n }\n]", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"Validation error\",\n \"message\": \"Record 0: Missing required field: code\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4e30c768-b984-4872-a15c-e29835b65e48", "name": "Unauthorized - invalid or missing API key", "originalRequest": { "url": { "path": [ "v1", "organization" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "full_load", "value": "false" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "[\n {\n \"name\": \"\",\n \"code\": \"\",\n \"organization_type\": \"\",\n \"parent_id\": \"\",\n \"active\": \"\",\n \"active_from\": \"\",\n \"active_to\": \"\",\n \"default_currency\": \"\",\n \"custom_field_1\": \"\",\n \"custom_field_2\": \"\",\n \"custom_field_3\": \"\",\n \"custom_field_4\": \"\",\n \"custom_field_5\": \"\",\n \"custom_field_6\": \"\",\n \"custom_field_7\": \"\",\n \"custom_field_8\": \"\",\n \"custom_field_9\": \"\",\n \"custom_field_10\": \"\",\n \"custom_field_11\": \"\",\n \"custom_field_12\": \"\",\n \"custom_field_13\": \"\",\n \"custom_field_14\": \"\",\n \"custom_field_15\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"identifiers\": [\n {\n \"identifier_label\": \"\",\n \"identifier_value\": \"\",\n \"identifier_type\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n },\n {\n \"identifier_label\": \"\",\n \"identifier_value\": \"\",\n \"identifier_type\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n ],\n \"addresses\": [\n {\n \"name\": \"\",\n \"street\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"\",\n \"country_code\": \"\",\n \"custom_field_1\": \"\",\n \"custom_field_2\": \"\",\n \"custom_field_3\": \"\",\n \"custom_field_4\": \"\",\n \"custom_field_5\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n },\n {\n \"name\": \"\",\n \"street\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"\",\n \"country_code\": \"\",\n \"custom_field_1\": \"\",\n \"custom_field_2\": \"\",\n \"custom_field_3\": \"\",\n \"custom_field_4\": \"\",\n \"custom_field_5\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n ]\n },\n {\n \"name\": \"\",\n \"code\": \"\",\n \"organization_type\": \"\",\n \"parent_id\": \"\",\n \"active\": \"\",\n \"active_from\": \"\",\n \"active_to\": \"\",\n \"default_currency\": \"\",\n \"custom_field_1\": \"\",\n \"custom_field_2\": \"\",\n \"custom_field_3\": \"\",\n \"custom_field_4\": \"\",\n \"custom_field_5\": \"\",\n \"custom_field_6\": \"\",\n \"custom_field_7\": \"\",\n \"custom_field_8\": \"\",\n \"custom_field_9\": \"\",\n \"custom_field_10\": \"\",\n \"custom_field_11\": \"\",\n \"custom_field_12\": \"\",\n \"custom_field_13\": \"\",\n \"custom_field_14\": \"\",\n \"custom_field_15\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"identifiers\": [\n {\n \"identifier_label\": \"\",\n \"identifier_value\": \"\",\n \"identifier_type\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n },\n {\n \"identifier_label\": \"\",\n \"identifier_value\": \"\",\n \"identifier_type\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n ],\n \"addresses\": [\n {\n \"name\": \"\",\n \"street\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"\",\n \"country_code\": \"\",\n \"custom_field_1\": \"\",\n \"custom_field_2\": \"\",\n \"custom_field_3\": \"\",\n \"custom_field_4\": \"\",\n \"custom_field_5\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n },\n {\n \"name\": \"\",\n \"street\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"\",\n \"country_code\": \"\",\n \"custom_field_1\": \"\",\n \"custom_field_2\": \"\",\n \"custom_field_3\": \"\",\n \"custom_field_4\": \"\",\n \"custom_field_5\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n ]\n }\n]", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"Unauthorized\",\n \"message\": \"API key is required\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "029cdfcf-d513-4877-9d73-cd2ca2accdda", "name": "Forbidden - insufficient permissions", "originalRequest": { "url": { "path": [ "v1", "organization" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "full_load", "value": "false" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "[\n {\n \"name\": \"\",\n \"code\": \"\",\n \"organization_type\": \"\",\n \"parent_id\": \"\",\n \"active\": \"\",\n \"active_from\": \"\",\n \"active_to\": \"\",\n \"default_currency\": \"\",\n \"custom_field_1\": \"\",\n \"custom_field_2\": \"\",\n \"custom_field_3\": \"\",\n \"custom_field_4\": \"\",\n \"custom_field_5\": \"\",\n \"custom_field_6\": \"\",\n \"custom_field_7\": \"\",\n \"custom_field_8\": \"\",\n \"custom_field_9\": \"\",\n \"custom_field_10\": \"\",\n \"custom_field_11\": \"\",\n \"custom_field_12\": \"\",\n \"custom_field_13\": \"\",\n \"custom_field_14\": \"\",\n \"custom_field_15\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"identifiers\": [\n {\n \"identifier_label\": \"\",\n \"identifier_value\": \"\",\n \"identifier_type\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n },\n {\n \"identifier_label\": \"\",\n \"identifier_value\": \"\",\n \"identifier_type\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n ],\n \"addresses\": [\n {\n \"name\": \"\",\n \"street\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"\",\n \"country_code\": \"\",\n \"custom_field_1\": \"\",\n \"custom_field_2\": \"\",\n \"custom_field_3\": \"\",\n \"custom_field_4\": \"\",\n \"custom_field_5\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n },\n {\n \"name\": \"\",\n \"street\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"\",\n \"country_code\": \"\",\n \"custom_field_1\": \"\",\n \"custom_field_2\": \"\",\n \"custom_field_3\": \"\",\n \"custom_field_4\": \"\",\n \"custom_field_5\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n ]\n },\n {\n \"name\": \"\",\n \"code\": \"\",\n \"organization_type\": \"\",\n \"parent_id\": \"\",\n \"active\": \"\",\n \"active_from\": \"\",\n \"active_to\": \"\",\n \"default_currency\": \"\",\n \"custom_field_1\": \"\",\n \"custom_field_2\": \"\",\n \"custom_field_3\": \"\",\n \"custom_field_4\": \"\",\n \"custom_field_5\": \"\",\n \"custom_field_6\": \"\",\n \"custom_field_7\": \"\",\n \"custom_field_8\": \"\",\n \"custom_field_9\": \"\",\n \"custom_field_10\": \"\",\n \"custom_field_11\": \"\",\n \"custom_field_12\": \"\",\n \"custom_field_13\": \"\",\n \"custom_field_14\": \"\",\n \"custom_field_15\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"identifiers\": [\n {\n \"identifier_label\": \"\",\n \"identifier_value\": \"\",\n \"identifier_type\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n },\n {\n \"identifier_label\": \"\",\n \"identifier_value\": \"\",\n \"identifier_type\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n ],\n \"addresses\": [\n {\n \"name\": \"\",\n \"street\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"\",\n \"country_code\": \"\",\n \"custom_field_1\": \"\",\n \"custom_field_2\": \"\",\n \"custom_field_3\": \"\",\n \"custom_field_4\": \"\",\n \"custom_field_5\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n },\n {\n \"name\": \"\",\n \"street\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"\",\n \"country_code\": \"\",\n \"custom_field_1\": \"\",\n \"custom_field_2\": \"\",\n \"custom_field_3\": \"\",\n \"custom_field_4\": \"\",\n \"custom_field_5\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n ]\n }\n]", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"Forbidden\",\n \"message\": \"API user does not have required permissions: POST_ORG, POST_DATA\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ef9dfc81-cccf-4e09-9639-8bab5c0475cd", "name": "Internal server error", "originalRequest": { "url": { "path": [ "v1", "organization" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "full_load", "value": "false" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "[\n {\n \"name\": \"\",\n \"code\": \"\",\n \"organization_type\": \"\",\n \"parent_id\": \"\",\n \"active\": \"\",\n \"active_from\": \"\",\n \"active_to\": \"\",\n \"default_currency\": \"\",\n \"custom_field_1\": \"\",\n \"custom_field_2\": \"\",\n \"custom_field_3\": \"\",\n \"custom_field_4\": \"\",\n \"custom_field_5\": \"\",\n \"custom_field_6\": \"\",\n \"custom_field_7\": \"\",\n \"custom_field_8\": \"\",\n \"custom_field_9\": \"\",\n \"custom_field_10\": \"\",\n \"custom_field_11\": \"\",\n \"custom_field_12\": \"\",\n \"custom_field_13\": \"\",\n \"custom_field_14\": \"\",\n \"custom_field_15\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"identifiers\": [\n {\n \"identifier_label\": \"\",\n \"identifier_value\": \"\",\n \"identifier_type\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n },\n {\n \"identifier_label\": \"\",\n \"identifier_value\": \"\",\n \"identifier_type\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n ],\n \"addresses\": [\n {\n \"name\": \"\",\n \"street\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"\",\n \"country_code\": \"\",\n \"custom_field_1\": \"\",\n \"custom_field_2\": \"\",\n \"custom_field_3\": \"\",\n \"custom_field_4\": \"\",\n \"custom_field_5\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n },\n {\n \"name\": \"\",\n \"street\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"\",\n \"country_code\": \"\",\n \"custom_field_1\": \"\",\n \"custom_field_2\": \"\",\n \"custom_field_3\": \"\",\n \"custom_field_4\": \"\",\n \"custom_field_5\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n ]\n },\n {\n \"name\": \"\",\n \"code\": \"\",\n \"organization_type\": \"\",\n \"parent_id\": \"\",\n \"active\": \"\",\n \"active_from\": \"\",\n \"active_to\": \"\",\n \"default_currency\": \"\",\n \"custom_field_1\": \"\",\n \"custom_field_2\": \"\",\n \"custom_field_3\": \"\",\n \"custom_field_4\": \"\",\n \"custom_field_5\": \"\",\n \"custom_field_6\": \"\",\n \"custom_field_7\": \"\",\n \"custom_field_8\": \"\",\n \"custom_field_9\": \"\",\n \"custom_field_10\": \"\",\n \"custom_field_11\": \"\",\n \"custom_field_12\": \"\",\n \"custom_field_13\": \"\",\n \"custom_field_14\": \"\",\n \"custom_field_15\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"identifiers\": [\n {\n \"identifier_label\": \"\",\n \"identifier_value\": \"\",\n \"identifier_type\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n },\n {\n \"identifier_label\": \"\",\n \"identifier_value\": \"\",\n \"identifier_type\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n ],\n \"addresses\": [\n {\n \"name\": \"\",\n \"street\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"\",\n \"country_code\": \"\",\n \"custom_field_1\": \"\",\n \"custom_field_2\": \"\",\n \"custom_field_3\": \"\",\n \"custom_field_4\": \"\",\n \"custom_field_5\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n },\n {\n \"name\": \"\",\n \"street\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"\",\n \"country_code\": \"\",\n \"custom_field_1\": \"\",\n \"custom_field_2\": \"\",\n \"custom_field_3\": \"\",\n \"custom_field_4\": \"\",\n \"custom_field_5\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n ]\n }\n]", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"Internal server error\",\n \"message\": \"Failed to insert organization units\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "279cc123-5de5-4d20-af30-1bebbcd69350", "name": "Delete organization units", "request": { "name": "Delete organization units", "description": { "content": "\nSoft delete or deactivate organization units based on filter criteria.\n\n**Actions** (organization_unit has no `is_deleted` column today; both actions are effectively soft-deactivations):\n- **delete**: Sets `active = false` and writes `'[DELETED]'` into `custom_field_15` as a sentinel so consumers can distinguish \"deleted\" from \"deactivated\".\n- **deactivate**: Sets `active = false`. `custom_field_15` is left untouched.\n\n**Filter Parameters**: Supports filtering by ID, code, organization type, and dates\n ", "type": "text/plain" }, "url": { "path": [ "v1", "organization" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"action\": \"\",\n \"parameters\": [\n {\n \"organization_unit_id\": \"\",\n \"code\": \"\",\n \"organization_type\": \"\",\n \"created_before_date\": \"\",\n \"created_after_date\": \"\",\n \"updated_before_date\": \"\",\n \"updated_after_date\": \"\"\n },\n {\n \"organization_unit_id\": \"\",\n \"code\": \"\",\n \"organization_type\": \"\",\n \"created_before_date\": \"\",\n \"created_after_date\": \"\",\n \"updated_before_date\": \"\",\n \"updated_after_date\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "98473a9d-0a2a-41fa-a5fe-fa43e2a82472", "name": "Delete/deactivate success", "originalRequest": { "url": { "path": [ "v1", "organization" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"action\": \"\",\n \"parameters\": [\n {\n \"organization_unit_id\": \"\",\n \"code\": \"\",\n \"organization_type\": \"\",\n \"created_before_date\": \"\",\n \"created_after_date\": \"\",\n \"updated_before_date\": \"\",\n \"updated_after_date\": \"\"\n },\n {\n \"organization_unit_id\": \"\",\n \"code\": \"\",\n \"organization_type\": \"\",\n \"created_before_date\": \"\",\n \"created_after_date\": \"\",\n \"updated_before_date\": \"\",\n \"updated_after_date\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Organization units deleted successfully\",\n \"organizationUnitIds\": [\n \"442e6ad6-a986-a259-3b26-538f91d16707\",\n \"4d41b87b-00de-cd8e-9711-e4688cbcd168\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0710145c-6dde-4bd9-b542-eeb1e7d297ab", "name": "Bad request - invalid action or parameters", "originalRequest": { "url": { "path": [ "v1", "organization" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"action\": \"\",\n \"parameters\": [\n {\n \"organization_unit_id\": \"\",\n \"code\": \"\",\n \"organization_type\": \"\",\n \"created_before_date\": \"\",\n \"created_after_date\": \"\",\n \"updated_before_date\": \"\",\n \"updated_after_date\": \"\"\n },\n {\n \"organization_unit_id\": \"\",\n \"code\": \"\",\n \"organization_type\": \"\",\n \"created_before_date\": \"\",\n \"created_after_date\": \"\",\n \"updated_before_date\": \"\",\n \"updated_after_date\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"Validation error\",\n \"message\": \"Action must be either \\\"delete\\\" or \\\"deactivate\\\"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2e44c943-eddf-4f6d-afdd-875908c9feb0", "name": "Unauthorized - invalid or missing API key", "originalRequest": { "url": { "path": [ "v1", "organization" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"action\": \"\",\n \"parameters\": [\n {\n \"organization_unit_id\": \"\",\n \"code\": \"\",\n \"organization_type\": \"\",\n \"created_before_date\": \"\",\n \"created_after_date\": \"\",\n \"updated_before_date\": \"\",\n \"updated_after_date\": \"\"\n },\n {\n \"organization_unit_id\": \"\",\n \"code\": \"\",\n \"organization_type\": \"\",\n \"created_before_date\": \"\",\n \"created_after_date\": \"\",\n \"updated_before_date\": \"\",\n \"updated_after_date\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"Unauthorized\",\n \"message\": \"API key is required\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9f40cebe-d8bb-43b3-a4d8-426e3f309160", "name": "Forbidden - insufficient permissions", "originalRequest": { "url": { "path": [ "v1", "organization" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"action\": \"\",\n \"parameters\": [\n {\n \"organization_unit_id\": \"\",\n \"code\": \"\",\n \"organization_type\": \"\",\n \"created_before_date\": \"\",\n \"created_after_date\": \"\",\n \"updated_before_date\": \"\",\n \"updated_after_date\": \"\"\n },\n {\n \"organization_unit_id\": \"\",\n \"code\": \"\",\n \"organization_type\": \"\",\n \"created_before_date\": \"\",\n \"created_after_date\": \"\",\n \"updated_before_date\": \"\",\n \"updated_after_date\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"Forbidden\",\n \"message\": \"API user does not have required permissions: POST_ORG, POST_DATA\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8ea09fc3-6371-4fc2-b04b-2c94b4c415d5", "name": "Internal server error", "originalRequest": { "url": { "path": [ "v1", "organization" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"action\": \"\",\n \"parameters\": [\n {\n \"organization_unit_id\": \"\",\n \"code\": \"\",\n \"organization_type\": \"\",\n \"created_before_date\": \"\",\n \"created_after_date\": \"\",\n \"updated_before_date\": \"\",\n \"updated_after_date\": \"\"\n },\n {\n \"organization_unit_id\": \"\",\n \"code\": \"\",\n \"organization_type\": \"\",\n \"created_before_date\": \"\",\n \"created_after_date\": \"\",\n \"updated_before_date\": \"\",\n \"updated_after_date\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"Internal server error\",\n \"message\": \"Failed to delete organization units\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "85b54fa0-e357-4213-b47e-647cdc31b12e", "name": "Payments", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "711074ef-67f3-4134-9146-5bb3a7478fc4", "name": "Upsert payment(s)", "request": { "name": "Upsert payment(s)", "description": { "content": "\nCreate or update one or more payment records, with optional invoice applications. Payments are identified by the\n`(external_source, external_payment_id)` natural key — re-posting with the same pair updates the existing row.\n\n**Body shape**: accepts either a single `PaymentCreateRequest` object OR an array of them.\n\n- **Single object** → 200 with `{ payment_id }` on success, or 400 with `{ message }` on validation failure.\n- **Array** → 200 with `{ results: [...] }` if every payment succeeded; **207 Multi-Status** with `{ results: [...] }` if at least one failed. Each result entry is `{ index, external_payment_id, ok, payment_id?, error? }`.\n\n**Required fields**: `external_payment_id`, `method`, `total_amount`, `currency`. `external_source` is strongly recommended (defaults to `'UNKNOWN'`) since the natural key collides without it.\n\n**Lines (invoice applications)**:\n- If `lines` is omitted: existing applications are untouched.\n- If `lines` is provided with `replace_lines = true` (default): all existing applications are deleted, then the new set is inserted.\n- If `lines` is provided with `replace_lines = false`: new applications are appended; existing ones stay.\n- Every line must include a valid `invoice_token` (UUID). Unknown tokens fail the whole payment with 400 `unknown invoice_token: ...`.\n\n**Auto-fill**: if `status` is `PAID` / `SETTLED` and `settled_at` is omitted, the API stamps `settled_at = now()`. Same for `RETURNED` → `returned_at`. Pass an explicit `null` to opt out.\n ", "type": "text/plain" }, "url": { "path": [ "v1", "payments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"external_payment_id\": \"\",\n \"method\": \"\",\n \"total_amount\": \"\",\n \"currency\": \"\",\n \"external_source\": \"UNKNOWN\",\n \"status\": \"\",\n \"scheduled_at\": \"\",\n \"submitted_at\": \"\",\n \"sent_at\": \"\",\n \"expected_settlement_at\": \"\",\n \"settled_at\": \"\",\n \"returned_at\": \"\",\n \"payment_reference\": \"\",\n \"bank_reference\": \"\",\n \"ach_trace_number\": \"\",\n \"sepa_end_to_end_id\": \"\",\n \"rtp_trace_id\": \"\",\n \"check_number\": \"\",\n \"check_mailed_at\": \"\",\n \"check_cleared_at\": \"\",\n \"check_stop_payment\": \"\",\n \"beneficiary_name\": \"\",\n \"beneficiary_bank_name\": \"\",\n \"beneficiary_bank_country\": \"\",\n \"beneficiary_swift_bic\": \"\",\n \"beneficiary_iban\": \"\",\n \"beneficiary_account\": \"\",\n \"beneficiary_routing\": \"\",\n \"payer_bank_name\": \"\",\n \"payer_bank_country\": \"\",\n \"payer_account\": \"\",\n \"payer_routing\": \"\",\n \"remittance_memo\": \"\",\n \"remittance_advice_url\": \"\",\n \"lines\": [\n {\n \"invoice_token\": \"\",\n \"applied_amount\": \"\",\n \"applied_currency\": \"\",\n \"fx_rate_line\": \"\",\n \"fx_at_line\": \"\",\n \"discount_amount\": \"\",\n \"discount_currency\": \"\",\n \"fee_amount_line\": \"\",\n \"fee_currency_line\": \"\",\n \"remittance_label\": \"Invoice\",\n \"remittance_value\": \"\",\n \"notes\": \"\"\n },\n {\n \"invoice_token\": \"\",\n \"applied_amount\": \"\",\n \"applied_currency\": \"\",\n \"fx_rate_line\": \"\",\n \"fx_at_line\": \"\",\n \"discount_amount\": \"\",\n \"discount_currency\": \"\",\n \"fee_amount_line\": \"\",\n \"fee_currency_line\": \"\",\n \"remittance_label\": \"Invoice\",\n \"remittance_value\": \"\",\n \"notes\": \"\"\n }\n ],\n \"replace_lines\": true\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "ea9e3ed2-9fd1-4c7d-9f32-a20a066b7a6b", "name": "Payment(s) created or updated — all succeeded", "originalRequest": { "url": { "path": [ "v1", "payments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"external_payment_id\": \"\",\n \"method\": \"\",\n \"total_amount\": \"\",\n \"currency\": \"\",\n \"external_source\": \"UNKNOWN\",\n \"status\": \"\",\n \"scheduled_at\": \"\",\n \"submitted_at\": \"\",\n \"sent_at\": \"\",\n \"expected_settlement_at\": \"\",\n \"settled_at\": \"\",\n \"returned_at\": \"\",\n \"payment_reference\": \"\",\n \"bank_reference\": \"\",\n \"ach_trace_number\": \"\",\n \"sepa_end_to_end_id\": \"\",\n \"rtp_trace_id\": \"\",\n \"check_number\": \"\",\n \"check_mailed_at\": \"\",\n \"check_cleared_at\": \"\",\n \"check_stop_payment\": \"\",\n \"beneficiary_name\": \"\",\n \"beneficiary_bank_name\": \"\",\n \"beneficiary_bank_country\": \"\",\n \"beneficiary_swift_bic\": \"\",\n \"beneficiary_iban\": \"\",\n \"beneficiary_account\": \"\",\n \"beneficiary_routing\": \"\",\n \"payer_bank_name\": \"\",\n \"payer_bank_country\": \"\",\n \"payer_account\": \"\",\n \"payer_routing\": \"\",\n \"remittance_memo\": \"\",\n \"remittance_advice_url\": \"\",\n \"lines\": [\n {\n \"invoice_token\": \"\",\n \"applied_amount\": \"\",\n \"applied_currency\": \"\",\n \"fx_rate_line\": \"\",\n \"fx_at_line\": \"\",\n \"discount_amount\": \"\",\n \"discount_currency\": \"\",\n \"fee_amount_line\": \"\",\n \"fee_currency_line\": \"\",\n \"remittance_label\": \"Invoice\",\n \"remittance_value\": \"\",\n \"notes\": \"\"\n },\n {\n \"invoice_token\": \"\",\n \"applied_amount\": \"\",\n \"applied_currency\": \"\",\n \"fx_rate_line\": \"\",\n \"fx_at_line\": \"\",\n \"discount_amount\": \"\",\n \"discount_currency\": \"\",\n \"fee_amount_line\": \"\",\n \"fee_currency_line\": \"\",\n \"remittance_label\": \"Invoice\",\n \"remittance_value\": \"\",\n \"notes\": \"\"\n }\n ],\n \"replace_lines\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"payment_id\": 3974\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c5db387d-adea-46bf-9f5c-44b8b1ed209b", "name": "Multi-Status — bulk mode where at least one payment in the array failed", "originalRequest": { "url": { "path": [ "v1", "payments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"external_payment_id\": \"\",\n \"method\": \"\",\n \"total_amount\": \"\",\n \"currency\": \"\",\n \"external_source\": \"UNKNOWN\",\n \"status\": \"\",\n \"scheduled_at\": \"\",\n \"submitted_at\": \"\",\n \"sent_at\": \"\",\n \"expected_settlement_at\": \"\",\n \"settled_at\": \"\",\n \"returned_at\": \"\",\n \"payment_reference\": \"\",\n \"bank_reference\": \"\",\n \"ach_trace_number\": \"\",\n \"sepa_end_to_end_id\": \"\",\n \"rtp_trace_id\": \"\",\n \"check_number\": \"\",\n \"check_mailed_at\": \"\",\n \"check_cleared_at\": \"\",\n \"check_stop_payment\": \"\",\n \"beneficiary_name\": \"\",\n \"beneficiary_bank_name\": \"\",\n \"beneficiary_bank_country\": \"\",\n \"beneficiary_swift_bic\": \"\",\n \"beneficiary_iban\": \"\",\n \"beneficiary_account\": \"\",\n \"beneficiary_routing\": \"\",\n \"payer_bank_name\": \"\",\n \"payer_bank_country\": \"\",\n \"payer_account\": \"\",\n \"payer_routing\": \"\",\n \"remittance_memo\": \"\",\n \"remittance_advice_url\": \"\",\n \"lines\": [\n {\n \"invoice_token\": \"\",\n \"applied_amount\": \"\",\n \"applied_currency\": \"\",\n \"fx_rate_line\": \"\",\n \"fx_at_line\": \"\",\n \"discount_amount\": \"\",\n \"discount_currency\": \"\",\n \"fee_amount_line\": \"\",\n \"fee_currency_line\": \"\",\n \"remittance_label\": \"Invoice\",\n \"remittance_value\": \"\",\n \"notes\": \"\"\n },\n {\n \"invoice_token\": \"\",\n \"applied_amount\": \"\",\n \"applied_currency\": \"\",\n \"fx_rate_line\": \"\",\n \"fx_at_line\": \"\",\n \"discount_amount\": \"\",\n \"discount_currency\": \"\",\n \"fee_amount_line\": \"\",\n \"fee_currency_line\": \"\",\n \"remittance_label\": \"Invoice\",\n \"remittance_value\": \"\",\n \"notes\": \"\"\n }\n ],\n \"replace_lines\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Multi-Status (WebDAV) (RFC 4918)", "code": 207, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"results\": [\n {\n \"index\": 7495,\n \"ok\": true,\n \"external_payment_id\": \"string\",\n \"payment_id\": 7599,\n \"error\": \"string\"\n },\n {\n \"index\": 7607,\n \"ok\": true,\n \"external_payment_id\": \"string\",\n \"payment_id\": 9069,\n \"error\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ac2b617c-6342-44b9-9aa2-e88915d35059", "name": "Bad request — single-payment mode validation error", "originalRequest": { "url": { "path": [ "v1", "payments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"external_payment_id\": \"\",\n \"method\": \"\",\n \"total_amount\": \"\",\n \"currency\": \"\",\n \"external_source\": \"UNKNOWN\",\n \"status\": \"\",\n \"scheduled_at\": \"\",\n \"submitted_at\": \"\",\n \"sent_at\": \"\",\n \"expected_settlement_at\": \"\",\n \"settled_at\": \"\",\n \"returned_at\": \"\",\n \"payment_reference\": \"\",\n \"bank_reference\": \"\",\n \"ach_trace_number\": \"\",\n \"sepa_end_to_end_id\": \"\",\n \"rtp_trace_id\": \"\",\n \"check_number\": \"\",\n \"check_mailed_at\": \"\",\n \"check_cleared_at\": \"\",\n \"check_stop_payment\": \"\",\n \"beneficiary_name\": \"\",\n \"beneficiary_bank_name\": \"\",\n \"beneficiary_bank_country\": \"\",\n \"beneficiary_swift_bic\": \"\",\n \"beneficiary_iban\": \"\",\n \"beneficiary_account\": \"\",\n \"beneficiary_routing\": \"\",\n \"payer_bank_name\": \"\",\n \"payer_bank_country\": \"\",\n \"payer_account\": \"\",\n \"payer_routing\": \"\",\n \"remittance_memo\": \"\",\n \"remittance_advice_url\": \"\",\n \"lines\": [\n {\n \"invoice_token\": \"\",\n \"applied_amount\": \"\",\n \"applied_currency\": \"\",\n \"fx_rate_line\": \"\",\n \"fx_at_line\": \"\",\n \"discount_amount\": \"\",\n \"discount_currency\": \"\",\n \"fee_amount_line\": \"\",\n \"fee_currency_line\": \"\",\n \"remittance_label\": \"Invoice\",\n \"remittance_value\": \"\",\n \"notes\": \"\"\n },\n {\n \"invoice_token\": \"\",\n \"applied_amount\": \"\",\n \"applied_currency\": \"\",\n \"fx_rate_line\": \"\",\n \"fx_at_line\": \"\",\n \"discount_amount\": \"\",\n \"discount_currency\": \"\",\n \"fee_amount_line\": \"\",\n \"fee_currency_line\": \"\",\n \"remittance_label\": \"Invoice\",\n \"remittance_value\": \"\",\n \"notes\": \"\"\n }\n ],\n \"replace_lines\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"missing required header fields\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e277dd2c-b13d-4826-b7d2-e03fb0678482", "name": "Unauthorized - invalid or missing API key", "originalRequest": { "url": { "path": [ "v1", "payments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"external_payment_id\": \"\",\n \"method\": \"\",\n \"total_amount\": \"\",\n \"currency\": \"\",\n \"external_source\": \"UNKNOWN\",\n \"status\": \"\",\n \"scheduled_at\": \"\",\n \"submitted_at\": \"\",\n \"sent_at\": \"\",\n \"expected_settlement_at\": \"\",\n \"settled_at\": \"\",\n \"returned_at\": \"\",\n \"payment_reference\": \"\",\n \"bank_reference\": \"\",\n \"ach_trace_number\": \"\",\n \"sepa_end_to_end_id\": \"\",\n \"rtp_trace_id\": \"\",\n \"check_number\": \"\",\n \"check_mailed_at\": \"\",\n \"check_cleared_at\": \"\",\n \"check_stop_payment\": \"\",\n \"beneficiary_name\": \"\",\n \"beneficiary_bank_name\": \"\",\n \"beneficiary_bank_country\": \"\",\n \"beneficiary_swift_bic\": \"\",\n \"beneficiary_iban\": \"\",\n \"beneficiary_account\": \"\",\n \"beneficiary_routing\": \"\",\n \"payer_bank_name\": \"\",\n \"payer_bank_country\": \"\",\n \"payer_account\": \"\",\n \"payer_routing\": \"\",\n \"remittance_memo\": \"\",\n \"remittance_advice_url\": \"\",\n \"lines\": [\n {\n \"invoice_token\": \"\",\n \"applied_amount\": \"\",\n \"applied_currency\": \"\",\n \"fx_rate_line\": \"\",\n \"fx_at_line\": \"\",\n \"discount_amount\": \"\",\n \"discount_currency\": \"\",\n \"fee_amount_line\": \"\",\n \"fee_currency_line\": \"\",\n \"remittance_label\": \"Invoice\",\n \"remittance_value\": \"\",\n \"notes\": \"\"\n },\n {\n \"invoice_token\": \"\",\n \"applied_amount\": \"\",\n \"applied_currency\": \"\",\n \"fx_rate_line\": \"\",\n \"fx_at_line\": \"\",\n \"discount_amount\": \"\",\n \"discount_currency\": \"\",\n \"fee_amount_line\": \"\",\n \"fee_currency_line\": \"\",\n \"remittance_label\": \"Invoice\",\n \"remittance_value\": \"\",\n \"notes\": \"\"\n }\n ],\n \"replace_lines\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"string\",\n \"code\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5b242407-c460-4b96-82d0-468409acaf52", "name": "Forbidden - insufficient permissions", "originalRequest": { "url": { "path": [ "v1", "payments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"external_payment_id\": \"\",\n \"method\": \"\",\n \"total_amount\": \"\",\n \"currency\": \"\",\n \"external_source\": \"UNKNOWN\",\n \"status\": \"\",\n \"scheduled_at\": \"\",\n \"submitted_at\": \"\",\n \"sent_at\": \"\",\n \"expected_settlement_at\": \"\",\n \"settled_at\": \"\",\n \"returned_at\": \"\",\n \"payment_reference\": \"\",\n \"bank_reference\": \"\",\n \"ach_trace_number\": \"\",\n \"sepa_end_to_end_id\": \"\",\n \"rtp_trace_id\": \"\",\n \"check_number\": \"\",\n \"check_mailed_at\": \"\",\n \"check_cleared_at\": \"\",\n \"check_stop_payment\": \"\",\n \"beneficiary_name\": \"\",\n \"beneficiary_bank_name\": \"\",\n \"beneficiary_bank_country\": \"\",\n \"beneficiary_swift_bic\": \"\",\n \"beneficiary_iban\": \"\",\n \"beneficiary_account\": \"\",\n \"beneficiary_routing\": \"\",\n \"payer_bank_name\": \"\",\n \"payer_bank_country\": \"\",\n \"payer_account\": \"\",\n \"payer_routing\": \"\",\n \"remittance_memo\": \"\",\n \"remittance_advice_url\": \"\",\n \"lines\": [\n {\n \"invoice_token\": \"\",\n \"applied_amount\": \"\",\n \"applied_currency\": \"\",\n \"fx_rate_line\": \"\",\n \"fx_at_line\": \"\",\n \"discount_amount\": \"\",\n \"discount_currency\": \"\",\n \"fee_amount_line\": \"\",\n \"fee_currency_line\": \"\",\n \"remittance_label\": \"Invoice\",\n \"remittance_value\": \"\",\n \"notes\": \"\"\n },\n {\n \"invoice_token\": \"\",\n \"applied_amount\": \"\",\n \"applied_currency\": \"\",\n \"fx_rate_line\": \"\",\n \"fx_at_line\": \"\",\n \"discount_amount\": \"\",\n \"discount_currency\": \"\",\n \"fee_amount_line\": \"\",\n \"fee_currency_line\": \"\",\n \"remittance_label\": \"Invoice\",\n \"remittance_value\": \"\",\n \"notes\": \"\"\n }\n ],\n \"replace_lines\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"Forbidden\",\n \"message\": \"API user does not have required permissions: POST_DATA\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6a59ef4d-64cc-4334-903a-6ce2cc11846e", "name": "Internal server error", "originalRequest": { "url": { "path": [ "v1", "payments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"external_payment_id\": \"\",\n \"method\": \"\",\n \"total_amount\": \"\",\n \"currency\": \"\",\n \"external_source\": \"UNKNOWN\",\n \"status\": \"\",\n \"scheduled_at\": \"\",\n \"submitted_at\": \"\",\n \"sent_at\": \"\",\n \"expected_settlement_at\": \"\",\n \"settled_at\": \"\",\n \"returned_at\": \"\",\n \"payment_reference\": \"\",\n \"bank_reference\": \"\",\n \"ach_trace_number\": \"\",\n \"sepa_end_to_end_id\": \"\",\n \"rtp_trace_id\": \"\",\n \"check_number\": \"\",\n \"check_mailed_at\": \"\",\n \"check_cleared_at\": \"\",\n \"check_stop_payment\": \"\",\n \"beneficiary_name\": \"\",\n \"beneficiary_bank_name\": \"\",\n \"beneficiary_bank_country\": \"\",\n \"beneficiary_swift_bic\": \"\",\n \"beneficiary_iban\": \"\",\n \"beneficiary_account\": \"\",\n \"beneficiary_routing\": \"\",\n \"payer_bank_name\": \"\",\n \"payer_bank_country\": \"\",\n \"payer_account\": \"\",\n \"payer_routing\": \"\",\n \"remittance_memo\": \"\",\n \"remittance_advice_url\": \"\",\n \"lines\": [\n {\n \"invoice_token\": \"\",\n \"applied_amount\": \"\",\n \"applied_currency\": \"\",\n \"fx_rate_line\": \"\",\n \"fx_at_line\": \"\",\n \"discount_amount\": \"\",\n \"discount_currency\": \"\",\n \"fee_amount_line\": \"\",\n \"fee_currency_line\": \"\",\n \"remittance_label\": \"Invoice\",\n \"remittance_value\": \"\",\n \"notes\": \"\"\n },\n {\n \"invoice_token\": \"\",\n \"applied_amount\": \"\",\n \"applied_currency\": \"\",\n \"fx_rate_line\": \"\",\n \"fx_at_line\": \"\",\n \"discount_amount\": \"\",\n \"discount_currency\": \"\",\n \"fee_amount_line\": \"\",\n \"fee_currency_line\": \"\",\n \"remittance_label\": \"Invoice\",\n \"remittance_value\": \"\",\n \"notes\": \"\"\n }\n ],\n \"replace_lines\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"string\",\n \"code\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ac39c7ec-34f7-448b-be55-dc1e351f13ad", "name": "Get payment", "request": { "name": "Get payment", "description": { "content": "Retrieves a payment record and its applications (invoice line entries) by `external_source` and `external_payment_id`.", "type": "text/plain" }, "url": { "path": [ "v1", "payments", ":source", ":external_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "source", "description": "(Required) External source system identifier (e.g. SAP, NETSUITE)" }, { "disabled": false, "type": "any", "value": "", "key": "external_id", "description": "(Required) External payment ID" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "3c1667b2-8a1a-4be8-acb6-d21051b2c8e4", "name": "Payment (header) and its applications (lines)", "originalRequest": { "url": { "path": [ "v1", "payments", ":source", ":external_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "source", "description": "(Required) External source system identifier (e.g. SAP, NETSUITE)" }, { "disabled": false, "type": "any", "value": "", "key": "external_id", "description": "(Required) External payment ID" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"payment\": {\n \"id\": 956,\n \"external_source\": \"string\",\n \"external_payment_id\": \"string\",\n \"status\": \"string\",\n \"method\": \"string\",\n \"total_amount\": 2593.496147782257,\n \"currency\": \"string\",\n \"scheduled_at\": \"1972-05-04T18:33:23.425Z\",\n \"submitted_at\": \"2007-04-22T01:27:19.946Z\",\n \"sent_at\": \"2011-08-04T19:51:14.610Z\",\n \"expected_settlement_at\": \"1977-07-10T20:35:05.630Z\",\n \"settled_at\": \"1980-09-11T15:11:25.243Z\",\n \"returned_at\": \"1975-04-11T00:46:47.310Z\",\n \"payment_reference\": \"string\",\n \"bank_reference\": \"string\",\n \"ach_trace_number\": \"string\",\n \"sepa_end_to_end_id\": \"string\",\n \"rtp_trace_id\": \"string\",\n \"check_number\": \"string\",\n \"check_mailed_at\": \"1987-02-04T13:23:18.950Z\",\n \"check_cleared_at\": \"1968-01-02T13:23:21.239Z\",\n \"check_stop_payment\": false,\n \"beneficiary_name\": \"string\",\n \"beneficiary_bank_name\": \"string\",\n \"beneficiary_bank_country\": \"string\",\n \"beneficiary_swift_bic\": \"string\",\n \"beneficiary_iban\": \"string\",\n \"beneficiary_account\": \"string\",\n \"beneficiary_routing\": \"string\",\n \"payer_bank_name\": \"string\",\n \"payer_bank_country\": \"string\",\n \"payer_account\": \"string\",\n \"payer_routing\": \"string\",\n \"remittance_memo\": \"string\",\n \"remittance_advice_url\": \"string\",\n \"created_by\": \"string\",\n \"created_via\": \"string\",\n \"created_at\": \"1995-07-26T12:55:45.244Z\",\n \"updated_at\": \"2009-05-23T19:00:18.421Z\",\n \"lines\": [\n {\n \"invoice_token\": \"\",\n \"applied_amount\": \"\",\n \"applied_currency\": \"\",\n \"fx_rate_line\": \"\",\n \"fx_at_line\": \"\",\n \"discount_amount\": \"\",\n \"discount_currency\": \"\",\n \"fee_amount_line\": \"\",\n \"fee_currency_line\": \"\",\n \"remittance_label\": \"Invoice\",\n \"remittance_value\": \"\",\n \"notes\": \"\"\n },\n {\n \"invoice_token\": \"\",\n \"applied_amount\": \"\",\n \"applied_currency\": \"\",\n \"fx_rate_line\": \"\",\n \"fx_at_line\": \"\",\n \"discount_amount\": \"\",\n \"discount_currency\": \"\",\n \"fee_amount_line\": \"\",\n \"fee_currency_line\": \"\",\n \"remittance_label\": \"Invoice\",\n \"remittance_value\": \"\",\n \"notes\": \"\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0cdef487-594e-443e-af34-0dd2e6084718", "name": "Unauthorized - invalid or missing API key", "originalRequest": { "url": { "path": [ "v1", "payments", ":source", ":external_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "source", "description": "(Required) External source system identifier (e.g. SAP, NETSUITE)" }, { "disabled": false, "type": "any", "value": "", "key": "external_id", "description": "(Required) External payment ID" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"string\",\n \"code\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f71798fb-2f4e-450e-8ef6-571fe8bc6b21", "name": "Forbidden - insufficient permissions", "originalRequest": { "url": { "path": [ "v1", "payments", ":source", ":external_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "source", "description": "(Required) External source system identifier (e.g. SAP, NETSUITE)" }, { "disabled": false, "type": "any", "value": "", "key": "external_id", "description": "(Required) External payment ID" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"Forbidden\",\n \"message\": \"API user does not have required permissions: READ_DATA\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1d54ec79-7150-4008-b782-c40e8543c8e7", "name": "Payment not found", "originalRequest": { "url": { "path": [ "v1", "payments", ":source", ":external_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "source", "description": "(Required) External source system identifier (e.g. SAP, NETSUITE)" }, { "disabled": false, "type": "any", "value": "", "key": "external_id", "description": "(Required) External payment ID" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"Not found\",\n \"message\": \"Payment not found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b35be58c-ebe1-4f5c-a485-cd063f8abf89", "name": "Internal server error", "originalRequest": { "url": { "path": [ "v1", "payments", ":source", ":external_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "source", "description": "(Required) External source system identifier (e.g. SAP, NETSUITE)" }, { "disabled": false, "type": "any", "value": "", "key": "external_id", "description": "(Required) External payment ID" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"string\",\n \"code\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6ba3a6bc-6571-4ab1-8fdf-ee02500a81af", "name": "List payments for invoice", "request": { "name": "List payments for invoice", "description": { "content": "Returns all payments that include applications referencing the specified invoice (by token).", "type": "text/plain" }, "url": { "path": [ "v1", "invoices", ":token", "payments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "token", "description": "(Required) Invoice token (UUID)" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "db7b6930-2bd2-4d03-a572-f241ef9b567c", "name": "Payments and their applications that reference the invoice", "originalRequest": { "url": { "path": [ "v1", "invoices", ":token", "payments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "token", "description": "(Required) Invoice token (UUID)" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"payments\": [\n {\n \"id\": 8891,\n \"external_source\": \"string\",\n \"external_payment_id\": \"string\",\n \"status\": \"string\",\n \"method\": \"string\",\n \"total_amount\": 7118.666934439075,\n \"currency\": \"string\",\n \"scheduled_at\": \"1995-11-13T13:14:59.457Z\",\n \"submitted_at\": \"2004-11-30T06:48:08.496Z\",\n \"sent_at\": \"1950-02-17T05:56:41.817Z\",\n \"expected_settlement_at\": \"1974-07-01T19:25:03.355Z\",\n \"settled_at\": \"1972-08-09T18:32:50.370Z\",\n \"returned_at\": \"1949-08-29T00:43:30.625Z\",\n \"payment_reference\": \"string\",\n \"bank_reference\": \"string\",\n \"ach_trace_number\": \"string\",\n \"sepa_end_to_end_id\": \"string\",\n \"rtp_trace_id\": \"string\",\n \"check_number\": \"string\",\n \"check_mailed_at\": \"1983-10-14T18:25:04.548Z\",\n \"check_cleared_at\": \"1998-09-15T00:29:15.708Z\",\n \"check_stop_payment\": false,\n \"beneficiary_name\": \"string\",\n \"beneficiary_bank_name\": \"string\",\n \"beneficiary_bank_country\": \"string\",\n \"beneficiary_swift_bic\": \"string\",\n \"beneficiary_iban\": \"string\",\n \"beneficiary_account\": \"string\",\n \"beneficiary_routing\": \"string\",\n \"payer_bank_name\": \"string\",\n \"payer_bank_country\": \"string\",\n \"payer_account\": \"string\",\n \"payer_routing\": \"string\",\n \"remittance_memo\": \"string\",\n \"remittance_advice_url\": \"string\",\n \"created_by\": \"string\",\n \"created_via\": \"string\",\n \"created_at\": \"2009-08-29T13:51:16.750Z\",\n \"updated_at\": \"1979-04-14T15:00:37.385Z\",\n \"lines\": [\n {\n \"invoice_token\": \"\",\n \"applied_amount\": \"\",\n \"applied_currency\": \"\",\n \"fx_rate_line\": \"\",\n \"fx_at_line\": \"\",\n \"discount_amount\": \"\",\n \"discount_currency\": \"\",\n \"fee_amount_line\": \"\",\n \"fee_currency_line\": \"\",\n \"remittance_label\": \"Invoice\",\n \"remittance_value\": \"\",\n \"notes\": \"\"\n },\n {\n \"invoice_token\": \"\",\n \"applied_amount\": \"\",\n \"applied_currency\": \"\",\n \"fx_rate_line\": \"\",\n \"fx_at_line\": \"\",\n \"discount_amount\": \"\",\n \"discount_currency\": \"\",\n \"fee_amount_line\": \"\",\n \"fee_currency_line\": \"\",\n \"remittance_label\": \"Invoice\",\n \"remittance_value\": \"\",\n \"notes\": \"\"\n }\n ]\n },\n {\n \"id\": 7566,\n \"external_source\": \"string\",\n \"external_payment_id\": \"string\",\n \"status\": \"string\",\n \"method\": \"string\",\n \"total_amount\": 3337.682474038972,\n \"currency\": \"string\",\n \"scheduled_at\": \"1977-10-23T10:44:21.559Z\",\n \"submitted_at\": \"1950-10-14T17:12:46.449Z\",\n \"sent_at\": \"1952-05-04T07:04:48.117Z\",\n \"expected_settlement_at\": \"1978-05-23T08:18:44.222Z\",\n \"settled_at\": \"1963-03-27T04:19:45.606Z\",\n \"returned_at\": \"1991-02-10T01:02:33.739Z\",\n \"payment_reference\": \"string\",\n \"bank_reference\": \"string\",\n \"ach_trace_number\": \"string\",\n \"sepa_end_to_end_id\": \"string\",\n \"rtp_trace_id\": \"string\",\n \"check_number\": \"string\",\n \"check_mailed_at\": \"2006-01-19T16:36:14.390Z\",\n \"check_cleared_at\": \"1954-05-30T02:11:08.783Z\",\n \"check_stop_payment\": false,\n \"beneficiary_name\": \"string\",\n \"beneficiary_bank_name\": \"string\",\n \"beneficiary_bank_country\": \"string\",\n \"beneficiary_swift_bic\": \"string\",\n \"beneficiary_iban\": \"string\",\n \"beneficiary_account\": \"string\",\n \"beneficiary_routing\": \"string\",\n \"payer_bank_name\": \"string\",\n \"payer_bank_country\": \"string\",\n \"payer_account\": \"string\",\n \"payer_routing\": \"string\",\n \"remittance_memo\": \"string\",\n \"remittance_advice_url\": \"string\",\n \"created_by\": \"string\",\n \"created_via\": \"string\",\n \"created_at\": \"1977-06-20T16:54:21.638Z\",\n \"updated_at\": \"2015-01-04T00:08:53.932Z\",\n \"lines\": [\n {\n \"invoice_token\": \"\",\n \"applied_amount\": \"\",\n \"applied_currency\": \"\",\n \"fx_rate_line\": \"\",\n \"fx_at_line\": \"\",\n \"discount_amount\": \"\",\n \"discount_currency\": \"\",\n \"fee_amount_line\": \"\",\n \"fee_currency_line\": \"\",\n \"remittance_label\": \"Invoice\",\n \"remittance_value\": \"\",\n \"notes\": \"\"\n },\n {\n \"invoice_token\": \"\",\n \"applied_amount\": \"\",\n \"applied_currency\": \"\",\n \"fx_rate_line\": \"\",\n \"fx_at_line\": \"\",\n \"discount_amount\": \"\",\n \"discount_currency\": \"\",\n \"fee_amount_line\": \"\",\n \"fee_currency_line\": \"\",\n \"remittance_label\": \"Invoice\",\n \"remittance_value\": \"\",\n \"notes\": \"\"\n }\n ]\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9a967c11-dcf2-4c00-8c5c-d52492ef4856", "name": "Unauthorized - invalid or missing API key", "originalRequest": { "url": { "path": [ "v1", "invoices", ":token", "payments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "token", "description": "(Required) Invoice token (UUID)" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"string\",\n \"code\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "023301bb-1216-4748-840b-c947f3462841", "name": "Forbidden - insufficient permissions", "originalRequest": { "url": { "path": [ "v1", "invoices", ":token", "payments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "token", "description": "(Required) Invoice token (UUID)" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"Forbidden\",\n \"message\": \"API user does not have required permissions: READ_DATA\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d297eeea-ef89-4d0a-8e37-164df49282cf", "name": "Invoice not found", "originalRequest": { "url": { "path": [ "v1", "invoices", ":token", "payments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "token", "description": "(Required) Invoice token (UUID)" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"Not found\",\n \"message\": \"Invoice not found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5ca92853-591c-4758-8c33-184944ce97aa", "name": "Internal server error", "originalRequest": { "url": { "path": [ "v1", "invoices", ":token", "payments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "token", "description": "(Required) Invoice token (UUID)" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"string\",\n \"code\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "b0af8d97-89b1-49ad-8f3c-6cf5addc510d", "name": "Purchase Order", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "c0bcf003-ba26-49d5-81c2-e6580a615bbc", "name": "List purchase orders", "request": { "name": "List purchase orders", "description": { "content": "Returns a paginated list of purchase orders. Only non-deleted records are returned.", "type": "text/plain" }, "url": { "path": [ "v1", "purchaseorder" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "key": "page", "value": "1", "description": "Page number for pagination" }, { "disabled": true, "key": "limit", "value": "1000", "description": "Number of records per page (max 1000)" }, { "disabled": true, "key": "po_number", "value": "", "description": "Filter by PO number (substring, case-insensitive)" }, { "disabled": true, "key": "source_document_id", "value": "", "description": "Filter by source document ID (substring, case-insensitive)" }, { "disabled": true, "key": "source_system", "value": "", "description": "Filter by source system (substring, case-insensitive)" }, { "disabled": true, "key": "status", "value": "", "description": "Filter by status (substring, case-insensitive)" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "d7915c89-9e15-4010-89ee-ecb21e49d7f8", "name": "List of purchase orders", "originalRequest": { "url": { "path": [ "v1", "purchaseorder" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "limit", "value": "1000" }, { "key": "po_number", "value": "" }, { "key": "source_document_id", "value": "" }, { "key": "source_system", "value": "" }, { "key": "status", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"count\": 8617,\n \"page\": 8828,\n \"totalPages\": 7375,\n \"purchase_orders\": [\n {\n \"po_number\": \"string\",\n \"supplier_code\": \"string\",\n \"organization_unit_code\": \"string\",\n \"source_document_id\": \"string\",\n \"source_system\": \"string\",\n \"po_date\": \"1998-03-31T20:29:23.897Z\",\n \"supplier_location_code\": \"string\",\n \"buyer\": \"string\",\n \"requester\": \"string\",\n \"status\": \"string\",\n \"currency_code\": \"string\",\n \"expected_delivery_date\": \"1976-10-18T19:17:37.161Z\",\n \"comments\": \"string\",\n \"net_amount\": 5665.25111622042,\n \"tax_amount\": 2337.7201341431664,\n \"gross_amount\": 7558.984776917164,\n \"source\": \"string\",\n \"is_deleted\": true,\n \"deleted_at\": \"1958-12-07T00:00:29.905Z\",\n \"created_at\": \"2023-09-07T03:47:17.715Z\",\n \"updated_at\": \"2013-10-27T22:24:07.745Z\",\n \"custom_text_1\": \"string\",\n \"custom_text_2\": \"string\",\n \"custom_text_3\": \"string\",\n \"custom_text_4\": \"string\",\n \"custom_text_5\": \"string\",\n \"custom_text_6\": \"string\",\n \"custom_text_7\": \"string\",\n \"custom_text_8\": \"string\",\n \"custom_text_9\": \"string\",\n \"custom_text_10\": \"string\",\n \"custom_text_11\": \"string\",\n \"custom_text_12\": \"string\",\n \"custom_text_13\": \"string\",\n \"custom_text_14\": \"string\",\n \"custom_text_15\": \"string\",\n \"custom_number_1\": 1460.349353766519,\n \"custom_number_2\": 9778.944147770097,\n \"custom_number_3\": 2567.188030981398,\n \"custom_number_4\": 9304.270570893379,\n \"custom_number_5\": 2591.1739815941414,\n \"custom_number_6\": 1032.096612359774,\n \"custom_number_7\": 4553.0546935946695,\n \"custom_number_8\": 9439.217519621383,\n \"custom_number_9\": 4993.650490228881,\n \"custom_number_10\": 5104.817639079409,\n \"custom_number_11\": 3533.5109092190864,\n \"custom_number_12\": 8079.574539871796,\n \"custom_number_13\": 2964.688083782032,\n \"custom_number_14\": 6046.49720729219,\n \"custom_number_15\": 8148.952544754553,\n \"custom_date_1\": \"1998-07-25\",\n \"custom_date_2\": \"1996-11-08\",\n \"custom_date_3\": \"1958-12-17\",\n \"custom_date_4\": \"1999-05-29\",\n \"custom_date_5\": \"1995-12-15\",\n \"custom_date_6\": \"1966-11-30\",\n \"custom_date_7\": \"1951-11-22\",\n \"custom_date_8\": \"2019-04-22\",\n \"custom_date_9\": \"1986-05-14\",\n \"custom_date_10\": \"2020-06-10\",\n \"custom_date_11\": \"1985-06-27\",\n \"custom_date_12\": \"2010-05-10\",\n \"custom_date_13\": \"2010-06-06\",\n \"custom_date_14\": \"1986-11-11\",\n \"custom_date_15\": \"1955-08-25\"\n },\n {\n \"po_number\": \"string\",\n \"supplier_code\": \"string\",\n \"organization_unit_code\": \"string\",\n \"source_document_id\": \"string\",\n \"source_system\": \"string\",\n \"po_date\": \"1961-10-26T10:21:39.217Z\",\n \"supplier_location_code\": \"string\",\n \"buyer\": \"string\",\n \"requester\": \"string\",\n \"status\": \"string\",\n \"currency_code\": \"string\",\n \"expected_delivery_date\": \"1999-12-31T14:25:36.335Z\",\n \"comments\": \"string\",\n \"net_amount\": 8456.267165422347,\n \"tax_amount\": 2959.070129128558,\n \"gross_amount\": 9001.685484464366,\n \"source\": \"string\",\n \"is_deleted\": true,\n \"deleted_at\": \"2013-05-16T03:10:53.314Z\",\n \"created_at\": \"1963-11-28T23:44:56.861Z\",\n \"updated_at\": \"2004-09-08T12:38:09.818Z\",\n \"custom_text_1\": \"string\",\n \"custom_text_2\": \"string\",\n \"custom_text_3\": \"string\",\n \"custom_text_4\": \"string\",\n \"custom_text_5\": \"string\",\n \"custom_text_6\": \"string\",\n \"custom_text_7\": \"string\",\n \"custom_text_8\": \"string\",\n \"custom_text_9\": \"string\",\n \"custom_text_10\": \"string\",\n \"custom_text_11\": \"string\",\n \"custom_text_12\": \"string\",\n \"custom_text_13\": \"string\",\n \"custom_text_14\": \"string\",\n \"custom_text_15\": \"string\",\n \"custom_number_1\": 3856.6386697028634,\n \"custom_number_2\": 2694.9795594956095,\n \"custom_number_3\": 316.0143848559782,\n \"custom_number_4\": 3185.460511698097,\n \"custom_number_5\": 3632.7988252479295,\n \"custom_number_6\": 6554.102796142421,\n \"custom_number_7\": 1894.279763566069,\n \"custom_number_8\": 9149.461995475362,\n \"custom_number_9\": 4788.2948132568035,\n \"custom_number_10\": 8255.512592590138,\n \"custom_number_11\": 1589.3424573898685,\n \"custom_number_12\": 5266.45030798224,\n \"custom_number_13\": 4907.426013774248,\n \"custom_number_14\": 6910.223388134003,\n \"custom_number_15\": 4063.2229168143376,\n \"custom_date_1\": \"1998-03-14\",\n \"custom_date_2\": \"2003-08-29\",\n \"custom_date_3\": \"2016-09-08\",\n \"custom_date_4\": \"1999-05-09\",\n \"custom_date_5\": \"2005-11-23\",\n \"custom_date_6\": \"2007-02-15\",\n \"custom_date_7\": \"2011-12-25\",\n \"custom_date_8\": \"1960-09-08\",\n \"custom_date_9\": \"1956-11-19\",\n \"custom_date_10\": \"1997-11-16\",\n \"custom_date_11\": \"2021-02-20\",\n \"custom_date_12\": \"1952-11-30\",\n \"custom_date_13\": \"1993-08-30\",\n \"custom_date_14\": \"2018-11-07\",\n \"custom_date_15\": \"2002-05-15\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1815801e-5066-4e5d-aa17-4d0eb996aa01", "name": "Unauthorized - invalid or missing API key", "originalRequest": { "url": { "path": [ "v1", "purchaseorder" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "limit", "value": "1000" }, { "key": "po_number", "value": "" }, { "key": "source_document_id", "value": "" }, { "key": "source_system", "value": "" }, { "key": "status", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"Unauthorized\",\n \"message\": \"API key is required\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2bd76625-2eeb-46ef-b889-a264c194955b", "name": "Forbidden - insufficient permissions", "originalRequest": { "url": { "path": [ "v1", "purchaseorder" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "limit", "value": "1000" }, { "key": "po_number", "value": "" }, { "key": "source_document_id", "value": "" }, { "key": "source_system", "value": "" }, { "key": "status", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"Forbidden\",\n \"message\": \"API user does not have required permissions: READ_PURCHASEORDER, READ_DATA\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4c7c87d7-33f7-4fdf-b492-9f2131bd014f", "name": "Internal server error", "originalRequest": { "url": { "path": [ "v1", "purchaseorder" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "limit", "value": "1000" }, { "key": "po_number", "value": "" }, { "key": "source_document_id", "value": "" }, { "key": "source_system", "value": "" }, { "key": "status", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"Internal server error\",\n \"message\": \"Database query failed\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "408cf004-9dce-43eb-8377-1a77c8dbb906", "name": "Upsert purchase orders", "request": { "name": "Upsert purchase orders", "description": { "content": "\nImport or update purchase orders. Supports both incremental updates and full data replacement.\n\n**Upsert Key**: source_document_id (`ON CONFLICT` target)\n\n**full_load Behavior**:\n- **false** (default): Incremental upsert — updates existing records (matched by source_document_id), inserts new ones\n- **true**: Full replacement — deletes ALL existing purchase orders for the customer, then inserts new data\n\n**Required Fields**: po_number, supplier_code, organization_unit_code, source_document_id, source_system\n\n**Limits**: maximum 1000 purchase orders per request.\n ", "type": "text/plain" }, "url": { "path": [ "v1", "purchaseorder" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "key": "full_load", "value": "false", "description": "If true, clears all existing purchase orders before inserting new data" } ], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "[\n {\n \"po_number\": \"\",\n \"supplier_code\": \"\",\n \"organization_unit_code\": \"\",\n \"source_document_id\": \"\",\n \"source_system\": \"\",\n \"po_date\": \"\",\n \"supplier_location_code\": \"\",\n \"buyer\": \"\",\n \"requester\": \"\",\n \"status\": \"\",\n \"currency_code\": \"\",\n \"expected_delivery_date\": \"\",\n \"comments\": \"\",\n \"net_amount\": \"\",\n \"tax_amount\": \"\",\n \"gross_amount\": \"\",\n \"source\": \"\",\n \"is_deleted\": \"\",\n \"deleted_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"custom_text_1\": \"\",\n \"custom_text_2\": \"\",\n \"custom_text_3\": \"\",\n \"custom_text_4\": \"\",\n \"custom_text_5\": \"\",\n \"custom_text_6\": \"\",\n \"custom_text_7\": \"\",\n \"custom_text_8\": \"\",\n \"custom_text_9\": \"\",\n \"custom_text_10\": \"\",\n \"custom_text_11\": \"\",\n \"custom_text_12\": \"\",\n \"custom_text_13\": \"\",\n \"custom_text_14\": \"\",\n \"custom_text_15\": \"\",\n \"custom_number_1\": \"\",\n \"custom_number_2\": \"\",\n \"custom_number_3\": \"\",\n \"custom_number_4\": \"\",\n \"custom_number_5\": \"\",\n \"custom_number_6\": \"\",\n \"custom_number_7\": \"\",\n \"custom_number_8\": \"\",\n \"custom_number_9\": \"\",\n \"custom_number_10\": \"\",\n \"custom_number_11\": \"\",\n \"custom_number_12\": \"\",\n \"custom_number_13\": \"\",\n \"custom_number_14\": \"\",\n \"custom_number_15\": \"\",\n \"custom_date_1\": \"\",\n \"custom_date_2\": \"\",\n \"custom_date_3\": \"\",\n \"custom_date_4\": \"\",\n \"custom_date_5\": \"\",\n \"custom_date_6\": \"\",\n \"custom_date_7\": \"\",\n \"custom_date_8\": \"\",\n \"custom_date_9\": \"\",\n \"custom_date_10\": \"\",\n \"custom_date_11\": \"\",\n \"custom_date_12\": \"\",\n \"custom_date_13\": \"\",\n \"custom_date_14\": \"\",\n \"custom_date_15\": \"\"\n },\n {\n \"po_number\": \"\",\n \"supplier_code\": \"\",\n \"organization_unit_code\": \"\",\n \"source_document_id\": \"\",\n \"source_system\": \"\",\n \"po_date\": \"\",\n \"supplier_location_code\": \"\",\n \"buyer\": \"\",\n \"requester\": \"\",\n \"status\": \"\",\n \"currency_code\": \"\",\n \"expected_delivery_date\": \"\",\n \"comments\": \"\",\n \"net_amount\": \"\",\n \"tax_amount\": \"\",\n \"gross_amount\": \"\",\n \"source\": \"\",\n \"is_deleted\": \"\",\n \"deleted_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"custom_text_1\": \"\",\n \"custom_text_2\": \"\",\n \"custom_text_3\": \"\",\n \"custom_text_4\": \"\",\n \"custom_text_5\": \"\",\n \"custom_text_6\": \"\",\n \"custom_text_7\": \"\",\n \"custom_text_8\": \"\",\n \"custom_text_9\": \"\",\n \"custom_text_10\": \"\",\n \"custom_text_11\": \"\",\n \"custom_text_12\": \"\",\n \"custom_text_13\": \"\",\n \"custom_text_14\": \"\",\n \"custom_text_15\": \"\",\n \"custom_number_1\": \"\",\n \"custom_number_2\": \"\",\n \"custom_number_3\": \"\",\n \"custom_number_4\": \"\",\n \"custom_number_5\": \"\",\n \"custom_number_6\": \"\",\n \"custom_number_7\": \"\",\n \"custom_number_8\": \"\",\n \"custom_number_9\": \"\",\n \"custom_number_10\": \"\",\n \"custom_number_11\": \"\",\n \"custom_number_12\": \"\",\n \"custom_number_13\": \"\",\n \"custom_number_14\": \"\",\n \"custom_number_15\": \"\",\n \"custom_date_1\": \"\",\n \"custom_date_2\": \"\",\n \"custom_date_3\": \"\",\n \"custom_date_4\": \"\",\n \"custom_date_5\": \"\",\n \"custom_date_6\": \"\",\n \"custom_date_7\": \"\",\n \"custom_date_8\": \"\",\n \"custom_date_9\": \"\",\n \"custom_date_10\": \"\",\n \"custom_date_11\": \"\",\n \"custom_date_12\": \"\",\n \"custom_date_13\": \"\",\n \"custom_date_14\": \"\",\n \"custom_date_15\": \"\"\n }\n]", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "55f647b9-2ba0-45a6-8cf4-07acc055caa1", "name": "Purchase orders inserted or updated successfully", "originalRequest": { "url": { "path": [ "v1", "purchaseorder" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "full_load", "value": "false" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "[\n {\n \"po_number\": \"\",\n \"supplier_code\": \"\",\n \"organization_unit_code\": \"\",\n \"source_document_id\": \"\",\n \"source_system\": \"\",\n \"po_date\": \"\",\n \"supplier_location_code\": \"\",\n \"buyer\": \"\",\n \"requester\": \"\",\n \"status\": \"\",\n \"currency_code\": \"\",\n \"expected_delivery_date\": \"\",\n \"comments\": \"\",\n \"net_amount\": \"\",\n \"tax_amount\": \"\",\n \"gross_amount\": \"\",\n \"source\": \"\",\n \"is_deleted\": \"\",\n \"deleted_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"custom_text_1\": \"\",\n \"custom_text_2\": \"\",\n \"custom_text_3\": \"\",\n \"custom_text_4\": \"\",\n \"custom_text_5\": \"\",\n \"custom_text_6\": \"\",\n \"custom_text_7\": \"\",\n \"custom_text_8\": \"\",\n \"custom_text_9\": \"\",\n \"custom_text_10\": \"\",\n \"custom_text_11\": \"\",\n \"custom_text_12\": \"\",\n \"custom_text_13\": \"\",\n \"custom_text_14\": \"\",\n \"custom_text_15\": \"\",\n \"custom_number_1\": \"\",\n \"custom_number_2\": \"\",\n \"custom_number_3\": \"\",\n \"custom_number_4\": \"\",\n \"custom_number_5\": \"\",\n \"custom_number_6\": \"\",\n \"custom_number_7\": \"\",\n \"custom_number_8\": \"\",\n \"custom_number_9\": \"\",\n \"custom_number_10\": \"\",\n \"custom_number_11\": \"\",\n \"custom_number_12\": \"\",\n \"custom_number_13\": \"\",\n \"custom_number_14\": \"\",\n \"custom_number_15\": \"\",\n \"custom_date_1\": \"\",\n \"custom_date_2\": \"\",\n \"custom_date_3\": \"\",\n \"custom_date_4\": \"\",\n \"custom_date_5\": \"\",\n \"custom_date_6\": \"\",\n \"custom_date_7\": \"\",\n \"custom_date_8\": \"\",\n \"custom_date_9\": \"\",\n \"custom_date_10\": \"\",\n \"custom_date_11\": \"\",\n \"custom_date_12\": \"\",\n \"custom_date_13\": \"\",\n \"custom_date_14\": \"\",\n \"custom_date_15\": \"\"\n },\n {\n \"po_number\": \"\",\n \"supplier_code\": \"\",\n \"organization_unit_code\": \"\",\n \"source_document_id\": \"\",\n \"source_system\": \"\",\n \"po_date\": \"\",\n \"supplier_location_code\": \"\",\n \"buyer\": \"\",\n \"requester\": \"\",\n \"status\": \"\",\n \"currency_code\": \"\",\n \"expected_delivery_date\": \"\",\n \"comments\": \"\",\n \"net_amount\": \"\",\n \"tax_amount\": \"\",\n \"gross_amount\": \"\",\n \"source\": \"\",\n \"is_deleted\": \"\",\n \"deleted_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"custom_text_1\": \"\",\n \"custom_text_2\": \"\",\n \"custom_text_3\": \"\",\n \"custom_text_4\": \"\",\n \"custom_text_5\": \"\",\n \"custom_text_6\": \"\",\n \"custom_text_7\": \"\",\n \"custom_text_8\": \"\",\n \"custom_text_9\": \"\",\n \"custom_text_10\": \"\",\n \"custom_text_11\": \"\",\n \"custom_text_12\": \"\",\n \"custom_text_13\": \"\",\n \"custom_text_14\": \"\",\n \"custom_text_15\": \"\",\n \"custom_number_1\": \"\",\n \"custom_number_2\": \"\",\n \"custom_number_3\": \"\",\n \"custom_number_4\": \"\",\n \"custom_number_5\": \"\",\n \"custom_number_6\": \"\",\n \"custom_number_7\": \"\",\n \"custom_number_8\": \"\",\n \"custom_number_9\": \"\",\n \"custom_number_10\": \"\",\n \"custom_number_11\": \"\",\n \"custom_number_12\": \"\",\n \"custom_number_13\": \"\",\n \"custom_number_14\": \"\",\n \"custom_number_15\": \"\",\n \"custom_date_1\": \"\",\n \"custom_date_2\": \"\",\n \"custom_date_3\": \"\",\n \"custom_date_4\": \"\",\n \"custom_date_5\": \"\",\n \"custom_date_6\": \"\",\n \"custom_date_7\": \"\",\n \"custom_date_8\": \"\",\n \"custom_date_9\": \"\",\n \"custom_date_10\": \"\",\n \"custom_date_11\": \"\",\n \"custom_date_12\": \"\",\n \"custom_date_13\": \"\",\n \"custom_date_14\": \"\",\n \"custom_date_15\": \"\"\n }\n]", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Purchase orders processed successfully\",\n \"ordersInserted\": 25\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cff87ffc-3820-4cae-8c16-c5065c0a4ae7", "name": "Bad request - validation error", "originalRequest": { "url": { "path": [ "v1", "purchaseorder" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "full_load", "value": "false" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "[\n {\n \"po_number\": \"\",\n \"supplier_code\": \"\",\n \"organization_unit_code\": \"\",\n \"source_document_id\": \"\",\n \"source_system\": \"\",\n \"po_date\": \"\",\n \"supplier_location_code\": \"\",\n \"buyer\": \"\",\n \"requester\": \"\",\n \"status\": \"\",\n \"currency_code\": \"\",\n \"expected_delivery_date\": \"\",\n \"comments\": \"\",\n \"net_amount\": \"\",\n \"tax_amount\": \"\",\n \"gross_amount\": \"\",\n \"source\": \"\",\n \"is_deleted\": \"\",\n \"deleted_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"custom_text_1\": \"\",\n \"custom_text_2\": \"\",\n \"custom_text_3\": \"\",\n \"custom_text_4\": \"\",\n \"custom_text_5\": \"\",\n \"custom_text_6\": \"\",\n \"custom_text_7\": \"\",\n \"custom_text_8\": \"\",\n \"custom_text_9\": \"\",\n \"custom_text_10\": \"\",\n \"custom_text_11\": \"\",\n \"custom_text_12\": \"\",\n \"custom_text_13\": \"\",\n \"custom_text_14\": \"\",\n \"custom_text_15\": \"\",\n \"custom_number_1\": \"\",\n \"custom_number_2\": \"\",\n \"custom_number_3\": \"\",\n \"custom_number_4\": \"\",\n \"custom_number_5\": \"\",\n \"custom_number_6\": \"\",\n \"custom_number_7\": \"\",\n \"custom_number_8\": \"\",\n \"custom_number_9\": \"\",\n \"custom_number_10\": \"\",\n \"custom_number_11\": \"\",\n \"custom_number_12\": \"\",\n \"custom_number_13\": \"\",\n \"custom_number_14\": \"\",\n \"custom_number_15\": \"\",\n \"custom_date_1\": \"\",\n \"custom_date_2\": \"\",\n \"custom_date_3\": \"\",\n \"custom_date_4\": \"\",\n \"custom_date_5\": \"\",\n \"custom_date_6\": \"\",\n \"custom_date_7\": \"\",\n \"custom_date_8\": \"\",\n \"custom_date_9\": \"\",\n \"custom_date_10\": \"\",\n \"custom_date_11\": \"\",\n \"custom_date_12\": \"\",\n \"custom_date_13\": \"\",\n \"custom_date_14\": \"\",\n \"custom_date_15\": \"\"\n },\n {\n \"po_number\": \"\",\n \"supplier_code\": \"\",\n \"organization_unit_code\": \"\",\n \"source_document_id\": \"\",\n \"source_system\": \"\",\n \"po_date\": \"\",\n \"supplier_location_code\": \"\",\n \"buyer\": \"\",\n \"requester\": \"\",\n \"status\": \"\",\n \"currency_code\": \"\",\n \"expected_delivery_date\": \"\",\n \"comments\": \"\",\n \"net_amount\": \"\",\n \"tax_amount\": \"\",\n \"gross_amount\": \"\",\n \"source\": \"\",\n \"is_deleted\": \"\",\n \"deleted_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"custom_text_1\": \"\",\n \"custom_text_2\": \"\",\n \"custom_text_3\": \"\",\n \"custom_text_4\": \"\",\n \"custom_text_5\": \"\",\n \"custom_text_6\": \"\",\n \"custom_text_7\": \"\",\n \"custom_text_8\": \"\",\n \"custom_text_9\": \"\",\n \"custom_text_10\": \"\",\n \"custom_text_11\": \"\",\n \"custom_text_12\": \"\",\n \"custom_text_13\": \"\",\n \"custom_text_14\": \"\",\n \"custom_text_15\": \"\",\n \"custom_number_1\": \"\",\n \"custom_number_2\": \"\",\n \"custom_number_3\": \"\",\n \"custom_number_4\": \"\",\n \"custom_number_5\": \"\",\n \"custom_number_6\": \"\",\n \"custom_number_7\": \"\",\n \"custom_number_8\": \"\",\n \"custom_number_9\": \"\",\n \"custom_number_10\": \"\",\n \"custom_number_11\": \"\",\n \"custom_number_12\": \"\",\n \"custom_number_13\": \"\",\n \"custom_number_14\": \"\",\n \"custom_number_15\": \"\",\n \"custom_date_1\": \"\",\n \"custom_date_2\": \"\",\n \"custom_date_3\": \"\",\n \"custom_date_4\": \"\",\n \"custom_date_5\": \"\",\n \"custom_date_6\": \"\",\n \"custom_date_7\": \"\",\n \"custom_date_8\": \"\",\n \"custom_date_9\": \"\",\n \"custom_date_10\": \"\",\n \"custom_date_11\": \"\",\n \"custom_date_12\": \"\",\n \"custom_date_13\": \"\",\n \"custom_date_14\": \"\",\n \"custom_date_15\": \"\"\n }\n]", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Purchase Order at index 0 is missing or has invalid \\\"po_number\\\".\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dc15cee2-70b2-43e9-a5ff-be0f444a49c1", "name": "Unauthorized - invalid or missing API key", "originalRequest": { "url": { "path": [ "v1", "purchaseorder" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "full_load", "value": "false" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "[\n {\n \"po_number\": \"\",\n \"supplier_code\": \"\",\n \"organization_unit_code\": \"\",\n \"source_document_id\": \"\",\n \"source_system\": \"\",\n \"po_date\": \"\",\n \"supplier_location_code\": \"\",\n \"buyer\": \"\",\n \"requester\": \"\",\n \"status\": \"\",\n \"currency_code\": \"\",\n \"expected_delivery_date\": \"\",\n \"comments\": \"\",\n \"net_amount\": \"\",\n \"tax_amount\": \"\",\n \"gross_amount\": \"\",\n \"source\": \"\",\n \"is_deleted\": \"\",\n \"deleted_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"custom_text_1\": \"\",\n \"custom_text_2\": \"\",\n \"custom_text_3\": \"\",\n \"custom_text_4\": \"\",\n \"custom_text_5\": \"\",\n \"custom_text_6\": \"\",\n \"custom_text_7\": \"\",\n \"custom_text_8\": \"\",\n \"custom_text_9\": \"\",\n \"custom_text_10\": \"\",\n \"custom_text_11\": \"\",\n \"custom_text_12\": \"\",\n \"custom_text_13\": \"\",\n \"custom_text_14\": \"\",\n \"custom_text_15\": \"\",\n \"custom_number_1\": \"\",\n \"custom_number_2\": \"\",\n \"custom_number_3\": \"\",\n \"custom_number_4\": \"\",\n \"custom_number_5\": \"\",\n \"custom_number_6\": \"\",\n \"custom_number_7\": \"\",\n \"custom_number_8\": \"\",\n \"custom_number_9\": \"\",\n \"custom_number_10\": \"\",\n \"custom_number_11\": \"\",\n \"custom_number_12\": \"\",\n \"custom_number_13\": \"\",\n \"custom_number_14\": \"\",\n \"custom_number_15\": \"\",\n \"custom_date_1\": \"\",\n \"custom_date_2\": \"\",\n \"custom_date_3\": \"\",\n \"custom_date_4\": \"\",\n \"custom_date_5\": \"\",\n \"custom_date_6\": \"\",\n \"custom_date_7\": \"\",\n \"custom_date_8\": \"\",\n \"custom_date_9\": \"\",\n \"custom_date_10\": \"\",\n \"custom_date_11\": \"\",\n \"custom_date_12\": \"\",\n \"custom_date_13\": \"\",\n \"custom_date_14\": \"\",\n \"custom_date_15\": \"\"\n },\n {\n \"po_number\": \"\",\n \"supplier_code\": \"\",\n \"organization_unit_code\": \"\",\n \"source_document_id\": \"\",\n \"source_system\": \"\",\n \"po_date\": \"\",\n \"supplier_location_code\": \"\",\n \"buyer\": \"\",\n \"requester\": \"\",\n \"status\": \"\",\n \"currency_code\": \"\",\n \"expected_delivery_date\": \"\",\n \"comments\": \"\",\n \"net_amount\": \"\",\n \"tax_amount\": \"\",\n \"gross_amount\": \"\",\n \"source\": \"\",\n \"is_deleted\": \"\",\n \"deleted_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"custom_text_1\": \"\",\n \"custom_text_2\": \"\",\n \"custom_text_3\": \"\",\n \"custom_text_4\": \"\",\n \"custom_text_5\": \"\",\n \"custom_text_6\": \"\",\n \"custom_text_7\": \"\",\n \"custom_text_8\": \"\",\n \"custom_text_9\": \"\",\n \"custom_text_10\": \"\",\n \"custom_text_11\": \"\",\n \"custom_text_12\": \"\",\n \"custom_text_13\": \"\",\n \"custom_text_14\": \"\",\n \"custom_text_15\": \"\",\n \"custom_number_1\": \"\",\n \"custom_number_2\": \"\",\n \"custom_number_3\": \"\",\n \"custom_number_4\": \"\",\n \"custom_number_5\": \"\",\n \"custom_number_6\": \"\",\n \"custom_number_7\": \"\",\n \"custom_number_8\": \"\",\n \"custom_number_9\": \"\",\n \"custom_number_10\": \"\",\n \"custom_number_11\": \"\",\n \"custom_number_12\": \"\",\n \"custom_number_13\": \"\",\n \"custom_number_14\": \"\",\n \"custom_number_15\": \"\",\n \"custom_date_1\": \"\",\n \"custom_date_2\": \"\",\n \"custom_date_3\": \"\",\n \"custom_date_4\": \"\",\n \"custom_date_5\": \"\",\n \"custom_date_6\": \"\",\n \"custom_date_7\": \"\",\n \"custom_date_8\": \"\",\n \"custom_date_9\": \"\",\n \"custom_date_10\": \"\",\n \"custom_date_11\": \"\",\n \"custom_date_12\": \"\",\n \"custom_date_13\": \"\",\n \"custom_date_14\": \"\",\n \"custom_date_15\": \"\"\n }\n]", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"Unauthorized\",\n \"message\": \"API key is required\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2fbf6ab2-d2b9-438e-b759-6cb1b918999a", "name": "Forbidden - insufficient permissions", "originalRequest": { "url": { "path": [ "v1", "purchaseorder" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "full_load", "value": "false" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "[\n {\n \"po_number\": \"\",\n \"supplier_code\": \"\",\n \"organization_unit_code\": \"\",\n \"source_document_id\": \"\",\n \"source_system\": \"\",\n \"po_date\": \"\",\n \"supplier_location_code\": \"\",\n \"buyer\": \"\",\n \"requester\": \"\",\n \"status\": \"\",\n \"currency_code\": \"\",\n \"expected_delivery_date\": \"\",\n \"comments\": \"\",\n \"net_amount\": \"\",\n \"tax_amount\": \"\",\n \"gross_amount\": \"\",\n \"source\": \"\",\n \"is_deleted\": \"\",\n \"deleted_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"custom_text_1\": \"\",\n \"custom_text_2\": \"\",\n \"custom_text_3\": \"\",\n \"custom_text_4\": \"\",\n \"custom_text_5\": \"\",\n \"custom_text_6\": \"\",\n \"custom_text_7\": \"\",\n \"custom_text_8\": \"\",\n \"custom_text_9\": \"\",\n \"custom_text_10\": \"\",\n \"custom_text_11\": \"\",\n \"custom_text_12\": \"\",\n \"custom_text_13\": \"\",\n \"custom_text_14\": \"\",\n \"custom_text_15\": \"\",\n \"custom_number_1\": \"\",\n \"custom_number_2\": \"\",\n \"custom_number_3\": \"\",\n \"custom_number_4\": \"\",\n \"custom_number_5\": \"\",\n \"custom_number_6\": \"\",\n \"custom_number_7\": \"\",\n \"custom_number_8\": \"\",\n \"custom_number_9\": \"\",\n \"custom_number_10\": \"\",\n \"custom_number_11\": \"\",\n \"custom_number_12\": \"\",\n \"custom_number_13\": \"\",\n \"custom_number_14\": \"\",\n \"custom_number_15\": \"\",\n \"custom_date_1\": \"\",\n \"custom_date_2\": \"\",\n \"custom_date_3\": \"\",\n \"custom_date_4\": \"\",\n \"custom_date_5\": \"\",\n \"custom_date_6\": \"\",\n \"custom_date_7\": \"\",\n \"custom_date_8\": \"\",\n \"custom_date_9\": \"\",\n \"custom_date_10\": \"\",\n \"custom_date_11\": \"\",\n \"custom_date_12\": \"\",\n \"custom_date_13\": \"\",\n \"custom_date_14\": \"\",\n \"custom_date_15\": \"\"\n },\n {\n \"po_number\": \"\",\n \"supplier_code\": \"\",\n \"organization_unit_code\": \"\",\n \"source_document_id\": \"\",\n \"source_system\": \"\",\n \"po_date\": \"\",\n \"supplier_location_code\": \"\",\n \"buyer\": \"\",\n \"requester\": \"\",\n \"status\": \"\",\n \"currency_code\": \"\",\n \"expected_delivery_date\": \"\",\n \"comments\": \"\",\n \"net_amount\": \"\",\n \"tax_amount\": \"\",\n \"gross_amount\": \"\",\n \"source\": \"\",\n \"is_deleted\": \"\",\n \"deleted_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"custom_text_1\": \"\",\n \"custom_text_2\": \"\",\n \"custom_text_3\": \"\",\n \"custom_text_4\": \"\",\n \"custom_text_5\": \"\",\n \"custom_text_6\": \"\",\n \"custom_text_7\": \"\",\n \"custom_text_8\": \"\",\n \"custom_text_9\": \"\",\n \"custom_text_10\": \"\",\n \"custom_text_11\": \"\",\n \"custom_text_12\": \"\",\n \"custom_text_13\": \"\",\n \"custom_text_14\": \"\",\n \"custom_text_15\": \"\",\n \"custom_number_1\": \"\",\n \"custom_number_2\": \"\",\n \"custom_number_3\": \"\",\n \"custom_number_4\": \"\",\n \"custom_number_5\": \"\",\n \"custom_number_6\": \"\",\n \"custom_number_7\": \"\",\n \"custom_number_8\": \"\",\n \"custom_number_9\": \"\",\n \"custom_number_10\": \"\",\n \"custom_number_11\": \"\",\n \"custom_number_12\": \"\",\n \"custom_number_13\": \"\",\n \"custom_number_14\": \"\",\n \"custom_number_15\": \"\",\n \"custom_date_1\": \"\",\n \"custom_date_2\": \"\",\n \"custom_date_3\": \"\",\n \"custom_date_4\": \"\",\n \"custom_date_5\": \"\",\n \"custom_date_6\": \"\",\n \"custom_date_7\": \"\",\n \"custom_date_8\": \"\",\n \"custom_date_9\": \"\",\n \"custom_date_10\": \"\",\n \"custom_date_11\": \"\",\n \"custom_date_12\": \"\",\n \"custom_date_13\": \"\",\n \"custom_date_14\": \"\",\n \"custom_date_15\": \"\"\n }\n]", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"Forbidden\",\n \"message\": \"API user does not have required permissions: POST_PURCHASEORDER, POST_DATA\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1ab8d0e8-a18a-4643-8353-3b6646324ee8", "name": "Internal server error", "originalRequest": { "url": { "path": [ "v1", "purchaseorder" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "full_load", "value": "false" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "[\n {\n \"po_number\": \"\",\n \"supplier_code\": \"\",\n \"organization_unit_code\": \"\",\n \"source_document_id\": \"\",\n \"source_system\": \"\",\n \"po_date\": \"\",\n \"supplier_location_code\": \"\",\n \"buyer\": \"\",\n \"requester\": \"\",\n \"status\": \"\",\n \"currency_code\": \"\",\n \"expected_delivery_date\": \"\",\n \"comments\": \"\",\n \"net_amount\": \"\",\n \"tax_amount\": \"\",\n \"gross_amount\": \"\",\n \"source\": \"\",\n \"is_deleted\": \"\",\n \"deleted_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"custom_text_1\": \"\",\n \"custom_text_2\": \"\",\n \"custom_text_3\": \"\",\n \"custom_text_4\": \"\",\n \"custom_text_5\": \"\",\n \"custom_text_6\": \"\",\n \"custom_text_7\": \"\",\n \"custom_text_8\": \"\",\n \"custom_text_9\": \"\",\n \"custom_text_10\": \"\",\n \"custom_text_11\": \"\",\n \"custom_text_12\": \"\",\n \"custom_text_13\": \"\",\n \"custom_text_14\": \"\",\n \"custom_text_15\": \"\",\n \"custom_number_1\": \"\",\n \"custom_number_2\": \"\",\n \"custom_number_3\": \"\",\n \"custom_number_4\": \"\",\n \"custom_number_5\": \"\",\n \"custom_number_6\": \"\",\n \"custom_number_7\": \"\",\n \"custom_number_8\": \"\",\n \"custom_number_9\": \"\",\n \"custom_number_10\": \"\",\n \"custom_number_11\": \"\",\n \"custom_number_12\": \"\",\n \"custom_number_13\": \"\",\n \"custom_number_14\": \"\",\n \"custom_number_15\": \"\",\n \"custom_date_1\": \"\",\n \"custom_date_2\": \"\",\n \"custom_date_3\": \"\",\n \"custom_date_4\": \"\",\n \"custom_date_5\": \"\",\n \"custom_date_6\": \"\",\n \"custom_date_7\": \"\",\n \"custom_date_8\": \"\",\n \"custom_date_9\": \"\",\n \"custom_date_10\": \"\",\n \"custom_date_11\": \"\",\n \"custom_date_12\": \"\",\n \"custom_date_13\": \"\",\n \"custom_date_14\": \"\",\n \"custom_date_15\": \"\"\n },\n {\n \"po_number\": \"\",\n \"supplier_code\": \"\",\n \"organization_unit_code\": \"\",\n \"source_document_id\": \"\",\n \"source_system\": \"\",\n \"po_date\": \"\",\n \"supplier_location_code\": \"\",\n \"buyer\": \"\",\n \"requester\": \"\",\n \"status\": \"\",\n \"currency_code\": \"\",\n \"expected_delivery_date\": \"\",\n \"comments\": \"\",\n \"net_amount\": \"\",\n \"tax_amount\": \"\",\n \"gross_amount\": \"\",\n \"source\": \"\",\n \"is_deleted\": \"\",\n \"deleted_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"custom_text_1\": \"\",\n \"custom_text_2\": \"\",\n \"custom_text_3\": \"\",\n \"custom_text_4\": \"\",\n \"custom_text_5\": \"\",\n \"custom_text_6\": \"\",\n \"custom_text_7\": \"\",\n \"custom_text_8\": \"\",\n \"custom_text_9\": \"\",\n \"custom_text_10\": \"\",\n \"custom_text_11\": \"\",\n \"custom_text_12\": \"\",\n \"custom_text_13\": \"\",\n \"custom_text_14\": \"\",\n \"custom_text_15\": \"\",\n \"custom_number_1\": \"\",\n \"custom_number_2\": \"\",\n \"custom_number_3\": \"\",\n \"custom_number_4\": \"\",\n \"custom_number_5\": \"\",\n \"custom_number_6\": \"\",\n \"custom_number_7\": \"\",\n \"custom_number_8\": \"\",\n \"custom_number_9\": \"\",\n \"custom_number_10\": \"\",\n \"custom_number_11\": \"\",\n \"custom_number_12\": \"\",\n \"custom_number_13\": \"\",\n \"custom_number_14\": \"\",\n \"custom_number_15\": \"\",\n \"custom_date_1\": \"\",\n \"custom_date_2\": \"\",\n \"custom_date_3\": \"\",\n \"custom_date_4\": \"\",\n \"custom_date_5\": \"\",\n \"custom_date_6\": \"\",\n \"custom_date_7\": \"\",\n \"custom_date_8\": \"\",\n \"custom_date_9\": \"\",\n \"custom_date_10\": \"\",\n \"custom_date_11\": \"\",\n \"custom_date_12\": \"\",\n \"custom_date_13\": \"\",\n \"custom_date_14\": \"\",\n \"custom_date_15\": \"\"\n }\n]", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"Internal server error\",\n \"message\": \"Failed to insert purchase orders\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7ac37a1e-80f9-4a2b-bfd8-fa5bcc94ebe9", "name": "Delete purchase orders", "request": { "name": "Delete purchase orders", "description": { "content": "\nSoft-delete purchase orders based on filter criteria. Sets `is_deleted = true`,\n`deleted_at = NOW()`, and `status = 'DELETED'`.\n\n**Cascade**: matched headers also soft-delete their child purchase_order_line\nrows (via `source_document_id`) and any purchase_order_receipt rows hanging\noff those lines (via `source_line_id`). You don't need to delete lines or\nreceipts separately.\n\n**No `action` field**: previous versions accepted `action: 'delete' | 'deactivate'`.\nThat parameter is no longer supported — the only supported behavior is\nsoft-delete. Sending `action` in the request body returns 400.\n\n**Filter parameters** array — each entry runs as one independent UPDATE; fields\nwithin an entry combine with AND. Maximum 50 filter entries per request.\n ", "type": "text/plain" }, "url": { "path": [ "v1", "purchaseorder" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"parameters\": [\n {\n \"po_number\": \"\",\n \"source_document_id\": \"\",\n \"source_system\": \"\",\n \"organization_unit_code\": \"\",\n \"po_date_before\": \"\",\n \"po_date_after\": \"\",\n \"created_before_date\": \"\",\n \"created_after_date\": \"\",\n \"updated_before_date\": \"\",\n \"updated_after_date\": \"\"\n },\n {\n \"po_number\": \"\",\n \"source_document_id\": \"\",\n \"source_system\": \"\",\n \"organization_unit_code\": \"\",\n \"po_date_before\": \"\",\n \"po_date_after\": \"\",\n \"created_before_date\": \"\",\n \"created_after_date\": \"\",\n \"updated_before_date\": \"\",\n \"updated_after_date\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "8c2fbad2-354c-42da-9a39-3bd89aadd685", "name": "Purchase orders soft-deleted successfully (lines and receipts cascaded)", "originalRequest": { "url": { "path": [ "v1", "purchaseorder" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"parameters\": [\n {\n \"po_number\": \"\",\n \"source_document_id\": \"\",\n \"source_system\": \"\",\n \"organization_unit_code\": \"\",\n \"po_date_before\": \"\",\n \"po_date_after\": \"\",\n \"created_before_date\": \"\",\n \"created_after_date\": \"\",\n \"updated_before_date\": \"\",\n \"updated_after_date\": \"\"\n },\n {\n \"po_number\": \"\",\n \"source_document_id\": \"\",\n \"source_system\": \"\",\n \"organization_unit_code\": \"\",\n \"po_date_before\": \"\",\n \"po_date_after\": \"\",\n \"created_before_date\": \"\",\n \"created_after_date\": \"\",\n \"updated_before_date\": \"\",\n \"updated_after_date\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"5 purchase order(s) soft-deleted successfully (lines and receipts cascaded).\",\n \"po_numbers\": [\n \"PO-2026-0001\",\n \"PO-2026-0002\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b6e7218d-b03c-4a5a-825f-547a4194b499", "name": "Bad request - legacy action field present, or missing parameters", "originalRequest": { "url": { "path": [ "v1", "purchaseorder" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"parameters\": [\n {\n \"po_number\": \"\",\n \"source_document_id\": \"\",\n \"source_system\": \"\",\n \"organization_unit_code\": \"\",\n \"po_date_before\": \"\",\n \"po_date_after\": \"\",\n \"created_before_date\": \"\",\n \"created_after_date\": \"\",\n \"updated_before_date\": \"\",\n \"updated_after_date\": \"\"\n },\n {\n \"po_number\": \"\",\n \"source_document_id\": \"\",\n \"source_system\": \"\",\n \"organization_unit_code\": \"\",\n \"po_date_before\": \"\",\n \"po_date_after\": \"\",\n \"created_before_date\": \"\",\n \"created_after_date\": \"\",\n \"updated_before_date\": \"\",\n \"updated_after_date\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"The \\\"action\\\" field is no longer accepted on /purchaseorder. DELETE now always soft-deletes (is_deleted = true). Remove \\\"action\\\" from your request body.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1d5bc9cb-1395-4294-beea-e1fab8e5d06b", "name": "Unauthorized - invalid or missing API key", "originalRequest": { "url": { "path": [ "v1", "purchaseorder" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"parameters\": [\n {\n \"po_number\": \"\",\n \"source_document_id\": \"\",\n \"source_system\": \"\",\n \"organization_unit_code\": \"\",\n \"po_date_before\": \"\",\n \"po_date_after\": \"\",\n \"created_before_date\": \"\",\n \"created_after_date\": \"\",\n \"updated_before_date\": \"\",\n \"updated_after_date\": \"\"\n },\n {\n \"po_number\": \"\",\n \"source_document_id\": \"\",\n \"source_system\": \"\",\n \"organization_unit_code\": \"\",\n \"po_date_before\": \"\",\n \"po_date_after\": \"\",\n \"created_before_date\": \"\",\n \"created_after_date\": \"\",\n \"updated_before_date\": \"\",\n \"updated_after_date\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"Unauthorized\",\n \"message\": \"API key is required\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9441190c-5180-4528-8f57-732495bc1a59", "name": "Forbidden - insufficient permissions", "originalRequest": { "url": { "path": [ "v1", "purchaseorder" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"parameters\": [\n {\n \"po_number\": \"\",\n \"source_document_id\": \"\",\n \"source_system\": \"\",\n \"organization_unit_code\": \"\",\n \"po_date_before\": \"\",\n \"po_date_after\": \"\",\n \"created_before_date\": \"\",\n \"created_after_date\": \"\",\n \"updated_before_date\": \"\",\n \"updated_after_date\": \"\"\n },\n {\n \"po_number\": \"\",\n \"source_document_id\": \"\",\n \"source_system\": \"\",\n \"organization_unit_code\": \"\",\n \"po_date_before\": \"\",\n \"po_date_after\": \"\",\n \"created_before_date\": \"\",\n \"created_after_date\": \"\",\n \"updated_before_date\": \"\",\n \"updated_after_date\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"Forbidden\",\n \"message\": \"API user does not have required permissions: POST_PURCHASEORDER, POST_DATA\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f1fc5c57-88ab-439c-97e5-2e4b844e97b2", "name": "No matching purchase orders found", "originalRequest": { "url": { "path": [ "v1", "purchaseorder" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"parameters\": [\n {\n \"po_number\": \"\",\n \"source_document_id\": \"\",\n \"source_system\": \"\",\n \"organization_unit_code\": \"\",\n \"po_date_before\": \"\",\n \"po_date_after\": \"\",\n \"created_before_date\": \"\",\n \"created_after_date\": \"\",\n \"updated_before_date\": \"\",\n \"updated_after_date\": \"\"\n },\n {\n \"po_number\": \"\",\n \"source_document_id\": \"\",\n \"source_system\": \"\",\n \"organization_unit_code\": \"\",\n \"po_date_before\": \"\",\n \"po_date_after\": \"\",\n \"created_before_date\": \"\",\n \"created_after_date\": \"\",\n \"updated_before_date\": \"\",\n \"updated_after_date\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"No matching purchase orders found.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c694d7ed-a6d9-4a5f-95f8-03750d4d0cb3", "name": "Internal server error", "originalRequest": { "url": { "path": [ "v1", "purchaseorder" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"parameters\": [\n {\n \"po_number\": \"\",\n \"source_document_id\": \"\",\n \"source_system\": \"\",\n \"organization_unit_code\": \"\",\n \"po_date_before\": \"\",\n \"po_date_after\": \"\",\n \"created_before_date\": \"\",\n \"created_after_date\": \"\",\n \"updated_before_date\": \"\",\n \"updated_after_date\": \"\"\n },\n {\n \"po_number\": \"\",\n \"source_document_id\": \"\",\n \"source_system\": \"\",\n \"organization_unit_code\": \"\",\n \"po_date_before\": \"\",\n \"po_date_after\": \"\",\n \"created_before_date\": \"\",\n \"created_after_date\": \"\",\n \"updated_before_date\": \"\",\n \"updated_after_date\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"Internal server error\",\n \"message\": \"Failed to delete purchase orders\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "bfeee53c-1904-4906-9218-2caf167bbca0", "name": "Purchase Order Line", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "71a4d6b9-db3b-4a4f-bfdc-7faeeac8b252", "name": "List purchase order lines", "request": { "name": "List purchase order lines", "description": { "content": "Returns a paginated list of purchase order line items. Only non-deleted records are returned.", "type": "text/plain" }, "url": { "path": [ "v1", "purchaseorderline" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "key": "page", "value": "1", "description": "Page number for pagination" }, { "disabled": true, "key": "limit", "value": "1000", "description": "Number of records per page (max 1000)" }, { "disabled": true, "key": "po_number", "value": "", "description": "Filter by PO number (exact match)" }, { "disabled": true, "key": "po_line_number", "value": "", "description": "Filter by PO line number (exact match)" }, { "disabled": true, "key": "source_document_id", "value": "", "description": "Filter by source document ID (exact match)" }, { "disabled": true, "key": "source_line_id", "value": "", "description": "Filter by source line ID (exact match)" }, { "disabled": true, "key": "product_code_1", "value": "", "description": "Filter by product code 1 (exact match)" }, { "disabled": true, "key": "buyer", "value": "", "description": "Filter by buyer (exact match)" }, { "disabled": true, "key": "requester", "value": "", "description": "Filter by requester (exact match)" }, { "disabled": true, "key": "status", "value": "", "description": "Filter by status (exact match)" }, { "disabled": true, "key": "currency_code", "value": "", "description": "Filter by currency code (exact match)" }, { "disabled": true, "key": "expected_delivery_date_before", "value": "", "description": "expected_delivery_date strictly before this timestamp" }, { "disabled": true, "key": "expected_delivery_date_after", "value": "", "description": "expected_delivery_date strictly after this timestamp" }, { "disabled": true, "key": "updated_at_before", "value": "", "description": "updated_at strictly before this timestamp" }, { "disabled": true, "key": "updated_at_after", "value": "", "description": "updated_at strictly after this timestamp" }, { "disabled": true, "key": "deleted_at_before", "value": "", "description": "deleted_at strictly before this timestamp" }, { "disabled": true, "key": "deleted_at_after", "value": "", "description": "deleted_at strictly after this timestamp" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "ba5925be-5c4f-4274-913d-8ab70d0634b3", "name": "List of purchase order lines", "originalRequest": { "url": { "path": [ "v1", "purchaseorderline" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "limit", "value": "1000" }, { "key": "po_number", "value": "" }, { "key": "po_line_number", "value": "" }, { "key": "source_document_id", "value": "" }, { "key": "source_line_id", "value": "" }, { "key": "product_code_1", "value": "" }, { "key": "buyer", "value": "" }, { "key": "requester", "value": "" }, { "key": "status", "value": "" }, { "key": "currency_code", "value": "" }, { "key": "expected_delivery_date_before", "value": "" }, { "key": "expected_delivery_date_after", "value": "" }, { "key": "updated_at_before", "value": "" }, { "key": "updated_at_after", "value": "" }, { "key": "deleted_at_before", "value": "" }, { "key": "deleted_at_after", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"count\": 4493,\n \"page\": 5472,\n \"totalPages\": 7233,\n \"purchase_order_lines\": [\n {\n \"po_number\": \"string\",\n \"po_line_number\": \"string\",\n \"source_document_id\": \"string\",\n \"source_line_id\": \"string\",\n \"quantity\": 94.39121049312548,\n \"unit_price\": 5788.762005442203,\n \"net_amount\": 2689.9818693156894,\n \"id\": \"ce509841-a4c6-bc08-cb3f-21045d3d232f\",\n \"line_type\": \"string\",\n \"product_code_1\": \"string\",\n \"product_name\": \"string\",\n \"product_code_2\": \"string\",\n \"unspsc_code\": \"string\",\n \"description\": \"string\",\n \"requester\": \"string\",\n \"buyer\": \"string\",\n \"unit_of_measure\": \"string\",\n \"currency_code\": \"string\",\n \"expected_delivery_date\": \"2013-02-09T00:42:19.845Z\",\n \"ship_to_location_code\": \"string\",\n \"tax_amount\": 7143.339191689226,\n \"gross_amount\": 3938.1627563779944,\n \"status\": \"string\",\n \"is_deleted\": false,\n \"deleted_at\": \"1986-07-04T00:24:08.001Z\",\n \"created_at\": \"1981-05-21T12:05:41.327Z\",\n \"updated_at\": \"1956-03-09T12:31:23.872Z\",\n \"custom_text_1\": \"string\",\n \"custom_text_2\": \"string\",\n \"custom_text_3\": \"string\",\n \"custom_text_4\": \"string\",\n \"custom_text_5\": \"string\",\n \"custom_text_6\": \"string\",\n \"custom_text_7\": \"string\",\n \"custom_text_8\": \"string\",\n \"custom_text_9\": \"string\",\n \"custom_text_10\": \"string\",\n \"custom_text_11\": \"string\",\n \"custom_text_12\": \"string\",\n \"custom_text_13\": \"string\",\n \"custom_text_14\": \"string\",\n \"custom_text_15\": \"string\",\n \"custom_number_1\": 4456.532456655511,\n \"custom_number_2\": 325.76768632659014,\n \"custom_number_3\": 938.5028207510793,\n \"custom_number_4\": 3654.4190714026213,\n \"custom_number_5\": 1078.1011071837354,\n \"custom_number_6\": 5986.953101510826,\n \"custom_number_7\": 9807.014341574391,\n \"custom_number_8\": 5850.401299218804,\n \"custom_number_9\": 2760.0738611176603,\n \"custom_number_10\": 3452.4066401412256,\n \"custom_date_1\": \"1986-08-27\",\n \"custom_date_2\": \"1968-05-21\",\n \"custom_date_3\": \"2008-08-03\",\n \"custom_date_4\": \"2004-04-15\",\n \"custom_date_5\": \"1967-05-21\",\n \"custom_date_6\": \"1955-02-19\",\n \"custom_date_7\": \"1991-01-22\",\n \"custom_date_8\": \"1975-02-15\",\n \"custom_date_9\": \"1981-04-09\",\n \"custom_date_10\": \"1952-02-17\"\n },\n {\n \"po_number\": \"string\",\n \"po_line_number\": \"string\",\n \"source_document_id\": \"string\",\n \"source_line_id\": \"string\",\n \"quantity\": 4532.695061094396,\n \"unit_price\": 4672.709883803561,\n \"net_amount\": 3192.5431437043762,\n \"id\": \"72ebcae2-eb5b-8baf-d105-ed25b6afbb67\",\n \"line_type\": \"string\",\n \"product_code_1\": \"string\",\n \"product_name\": \"string\",\n \"product_code_2\": \"string\",\n \"unspsc_code\": \"string\",\n \"description\": \"string\",\n \"requester\": \"string\",\n \"buyer\": \"string\",\n \"unit_of_measure\": \"string\",\n \"currency_code\": \"string\",\n \"expected_delivery_date\": \"1990-09-19T01:49:49.436Z\",\n \"ship_to_location_code\": \"string\",\n \"tax_amount\": 4156.327003890705,\n \"gross_amount\": 249.3720329729343,\n \"status\": \"string\",\n \"is_deleted\": true,\n \"deleted_at\": \"2023-04-10T09:57:53.939Z\",\n \"created_at\": \"1999-02-05T14:45:05.473Z\",\n \"updated_at\": \"2007-02-01T11:24:21.555Z\",\n \"custom_text_1\": \"string\",\n \"custom_text_2\": \"string\",\n \"custom_text_3\": \"string\",\n \"custom_text_4\": \"string\",\n \"custom_text_5\": \"string\",\n \"custom_text_6\": \"string\",\n \"custom_text_7\": \"string\",\n \"custom_text_8\": \"string\",\n \"custom_text_9\": \"string\",\n \"custom_text_10\": \"string\",\n \"custom_text_11\": \"string\",\n \"custom_text_12\": \"string\",\n \"custom_text_13\": \"string\",\n \"custom_text_14\": \"string\",\n \"custom_text_15\": \"string\",\n \"custom_number_1\": 2003.6426200514645,\n \"custom_number_2\": 6164.84588364947,\n \"custom_number_3\": 5432.945263778228,\n \"custom_number_4\": 2898.2851689937484,\n \"custom_number_5\": 6522.56555423592,\n \"custom_number_6\": 9696.307600758504,\n \"custom_number_7\": 8773.207959882579,\n \"custom_number_8\": 9847.400378551301,\n \"custom_number_9\": 5867.70665868891,\n \"custom_number_10\": 7172.642094095896,\n \"custom_date_1\": \"1949-05-14\",\n \"custom_date_2\": \"1996-02-19\",\n \"custom_date_3\": \"1968-05-10\",\n \"custom_date_4\": \"1967-01-05\",\n \"custom_date_5\": \"2023-09-21\",\n \"custom_date_6\": \"1983-06-09\",\n \"custom_date_7\": \"1965-09-01\",\n \"custom_date_8\": \"1957-10-13\",\n \"custom_date_9\": \"2022-01-18\",\n \"custom_date_10\": \"1952-06-04\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6f332a6c-8eff-4859-8b96-56b61b73d3a4", "name": "Unauthorized - invalid or missing API key", "originalRequest": { "url": { "path": [ "v1", "purchaseorderline" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "limit", "value": "1000" }, { "key": "po_number", "value": "" }, { "key": "po_line_number", "value": "" }, { "key": "source_document_id", "value": "" }, { "key": "source_line_id", "value": "" }, { "key": "product_code_1", "value": "" }, { "key": "buyer", "value": "" }, { "key": "requester", "value": "" }, { "key": "status", "value": "" }, { "key": "currency_code", "value": "" }, { "key": "expected_delivery_date_before", "value": "" }, { "key": "expected_delivery_date_after", "value": "" }, { "key": "updated_at_before", "value": "" }, { "key": "updated_at_after", "value": "" }, { "key": "deleted_at_before", "value": "" }, { "key": "deleted_at_after", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"string\",\n \"code\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1dbeed59-0af7-4a42-8e53-e3246a01fd18", "name": "Forbidden - insufficient permissions", "originalRequest": { "url": { "path": [ "v1", "purchaseorderline" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "limit", "value": "1000" }, { "key": "po_number", "value": "" }, { "key": "po_line_number", "value": "" }, { "key": "source_document_id", "value": "" }, { "key": "source_line_id", "value": "" }, { "key": "product_code_1", "value": "" }, { "key": "buyer", "value": "" }, { "key": "requester", "value": "" }, { "key": "status", "value": "" }, { "key": "currency_code", "value": "" }, { "key": "expected_delivery_date_before", "value": "" }, { "key": "expected_delivery_date_after", "value": "" }, { "key": "updated_at_before", "value": "" }, { "key": "updated_at_after", "value": "" }, { "key": "deleted_at_before", "value": "" }, { "key": "deleted_at_after", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"Forbidden\",\n \"message\": \"API user does not have required permissions: READ_PURCHASEORDER, READ_DATA\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ae47bb2d-6458-42e9-9447-32b107b4b2ae", "name": "Internal server error", "originalRequest": { "url": { "path": [ "v1", "purchaseorderline" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "limit", "value": "1000" }, { "key": "po_number", "value": "" }, { "key": "po_line_number", "value": "" }, { "key": "source_document_id", "value": "" }, { "key": "source_line_id", "value": "" }, { "key": "product_code_1", "value": "" }, { "key": "buyer", "value": "" }, { "key": "requester", "value": "" }, { "key": "status", "value": "" }, { "key": "currency_code", "value": "" }, { "key": "expected_delivery_date_before", "value": "" }, { "key": "expected_delivery_date_after", "value": "" }, { "key": "updated_at_before", "value": "" }, { "key": "updated_at_after", "value": "" }, { "key": "deleted_at_before", "value": "" }, { "key": "deleted_at_after", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"string\",\n \"code\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "66c1c682-118b-4db8-b6ee-e905e2bb278f", "name": "Upsert purchase order lines", "request": { "name": "Upsert purchase order lines", "description": { "content": "\nImport or update purchase order line items. Supports both incremental updates and full data replacement.\n\n**Upsert Key**: source_line_id (`ON CONFLICT` target)\n\n**full_load Behavior**:\n- **false** (default): Incremental upsert — updates existing lines (matched by source_line_id), inserts new ones\n- **true**: Full replacement — deletes ALL existing purchase order lines for the customer, then inserts new data\n\n**Required Fields**: po_number, po_line_number, source_document_id, source_line_id, quantity, unit_price, net_amount\n\n**Referential integrity**: every `source_document_id` must reference an existing purchase_order row, or the request is rejected with 400.\n\n**Limits**: maximum 1000 lines per request.\n ", "type": "text/plain" }, "url": { "path": [ "v1", "purchaseorderline" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "key": "full_load", "value": "false", "description": "If true, deletes ALL existing purchase order lines before inserting new data" } ], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "[\n {\n \"po_number\": \"\",\n \"po_line_number\": \"\",\n \"source_document_id\": \"\",\n \"source_line_id\": \"\",\n \"quantity\": \"\",\n \"unit_price\": \"\",\n \"net_amount\": \"\",\n \"id\": \"\",\n \"line_type\": \"\",\n \"product_code_1\": \"\",\n \"product_name\": \"\",\n \"product_code_2\": \"\",\n \"unspsc_code\": \"\",\n \"description\": \"\",\n \"requester\": \"\",\n \"buyer\": \"\",\n \"unit_of_measure\": \"\",\n \"currency_code\": \"\",\n \"expected_delivery_date\": \"\",\n \"ship_to_location_code\": \"\",\n \"tax_amount\": \"\",\n \"gross_amount\": \"\",\n \"status\": \"\",\n \"is_deleted\": \"\",\n \"deleted_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"custom_text_1\": \"\",\n \"custom_text_2\": \"\",\n \"custom_text_3\": \"\",\n \"custom_text_4\": \"\",\n \"custom_text_5\": \"\",\n \"custom_text_6\": \"\",\n \"custom_text_7\": \"\",\n \"custom_text_8\": \"\",\n \"custom_text_9\": \"\",\n \"custom_text_10\": \"\",\n \"custom_text_11\": \"\",\n \"custom_text_12\": \"\",\n \"custom_text_13\": \"\",\n \"custom_text_14\": \"\",\n \"custom_text_15\": \"\",\n \"custom_number_1\": \"\",\n \"custom_number_2\": \"\",\n \"custom_number_3\": \"\",\n \"custom_number_4\": \"\",\n \"custom_number_5\": \"\",\n \"custom_number_6\": \"\",\n \"custom_number_7\": \"\",\n \"custom_number_8\": \"\",\n \"custom_number_9\": \"\",\n \"custom_number_10\": \"\",\n \"custom_date_1\": \"\",\n \"custom_date_2\": \"\",\n \"custom_date_3\": \"\",\n \"custom_date_4\": \"\",\n \"custom_date_5\": \"\",\n \"custom_date_6\": \"\",\n \"custom_date_7\": \"\",\n \"custom_date_8\": \"\",\n \"custom_date_9\": \"\",\n \"custom_date_10\": \"\"\n },\n {\n \"po_number\": \"\",\n \"po_line_number\": \"\",\n \"source_document_id\": \"\",\n \"source_line_id\": \"\",\n \"quantity\": \"\",\n \"unit_price\": \"\",\n \"net_amount\": \"\",\n \"id\": \"\",\n \"line_type\": \"\",\n \"product_code_1\": \"\",\n \"product_name\": \"\",\n \"product_code_2\": \"\",\n \"unspsc_code\": \"\",\n \"description\": \"\",\n \"requester\": \"\",\n \"buyer\": \"\",\n \"unit_of_measure\": \"\",\n \"currency_code\": \"\",\n \"expected_delivery_date\": \"\",\n \"ship_to_location_code\": \"\",\n \"tax_amount\": \"\",\n \"gross_amount\": \"\",\n \"status\": \"\",\n \"is_deleted\": \"\",\n \"deleted_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"custom_text_1\": \"\",\n \"custom_text_2\": \"\",\n \"custom_text_3\": \"\",\n \"custom_text_4\": \"\",\n \"custom_text_5\": \"\",\n \"custom_text_6\": \"\",\n \"custom_text_7\": \"\",\n \"custom_text_8\": \"\",\n \"custom_text_9\": \"\",\n \"custom_text_10\": \"\",\n \"custom_text_11\": \"\",\n \"custom_text_12\": \"\",\n \"custom_text_13\": \"\",\n \"custom_text_14\": \"\",\n \"custom_text_15\": \"\",\n \"custom_number_1\": \"\",\n \"custom_number_2\": \"\",\n \"custom_number_3\": \"\",\n \"custom_number_4\": \"\",\n \"custom_number_5\": \"\",\n \"custom_number_6\": \"\",\n \"custom_number_7\": \"\",\n \"custom_number_8\": \"\",\n \"custom_number_9\": \"\",\n \"custom_number_10\": \"\",\n \"custom_date_1\": \"\",\n \"custom_date_2\": \"\",\n \"custom_date_3\": \"\",\n \"custom_date_4\": \"\",\n \"custom_date_5\": \"\",\n \"custom_date_6\": \"\",\n \"custom_date_7\": \"\",\n \"custom_date_8\": \"\",\n \"custom_date_9\": \"\",\n \"custom_date_10\": \"\"\n }\n]", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "d49917e6-ae22-4d52-a521-27aa008db64e", "name": "Purchase order lines processed successfully", "originalRequest": { "url": { "path": [ "v1", "purchaseorderline" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "full_load", "value": "false" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "[\n {\n \"po_number\": \"\",\n \"po_line_number\": \"\",\n \"source_document_id\": \"\",\n \"source_line_id\": \"\",\n \"quantity\": \"\",\n \"unit_price\": \"\",\n \"net_amount\": \"\",\n \"id\": \"\",\n \"line_type\": \"\",\n \"product_code_1\": \"\",\n \"product_name\": \"\",\n \"product_code_2\": \"\",\n \"unspsc_code\": \"\",\n \"description\": \"\",\n \"requester\": \"\",\n \"buyer\": \"\",\n \"unit_of_measure\": \"\",\n \"currency_code\": \"\",\n \"expected_delivery_date\": \"\",\n \"ship_to_location_code\": \"\",\n \"tax_amount\": \"\",\n \"gross_amount\": \"\",\n \"status\": \"\",\n \"is_deleted\": \"\",\n \"deleted_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"custom_text_1\": \"\",\n \"custom_text_2\": \"\",\n \"custom_text_3\": \"\",\n \"custom_text_4\": \"\",\n \"custom_text_5\": \"\",\n \"custom_text_6\": \"\",\n \"custom_text_7\": \"\",\n \"custom_text_8\": \"\",\n \"custom_text_9\": \"\",\n \"custom_text_10\": \"\",\n \"custom_text_11\": \"\",\n \"custom_text_12\": \"\",\n \"custom_text_13\": \"\",\n \"custom_text_14\": \"\",\n \"custom_text_15\": \"\",\n \"custom_number_1\": \"\",\n \"custom_number_2\": \"\",\n \"custom_number_3\": \"\",\n \"custom_number_4\": \"\",\n \"custom_number_5\": \"\",\n \"custom_number_6\": \"\",\n \"custom_number_7\": \"\",\n \"custom_number_8\": \"\",\n \"custom_number_9\": \"\",\n \"custom_number_10\": \"\",\n \"custom_date_1\": \"\",\n \"custom_date_2\": \"\",\n \"custom_date_3\": \"\",\n \"custom_date_4\": \"\",\n \"custom_date_5\": \"\",\n \"custom_date_6\": \"\",\n \"custom_date_7\": \"\",\n \"custom_date_8\": \"\",\n \"custom_date_9\": \"\",\n \"custom_date_10\": \"\"\n },\n {\n \"po_number\": \"\",\n \"po_line_number\": \"\",\n \"source_document_id\": \"\",\n \"source_line_id\": \"\",\n \"quantity\": \"\",\n \"unit_price\": \"\",\n \"net_amount\": \"\",\n \"id\": \"\",\n \"line_type\": \"\",\n \"product_code_1\": \"\",\n \"product_name\": \"\",\n \"product_code_2\": \"\",\n \"unspsc_code\": \"\",\n \"description\": \"\",\n \"requester\": \"\",\n \"buyer\": \"\",\n \"unit_of_measure\": \"\",\n \"currency_code\": \"\",\n \"expected_delivery_date\": \"\",\n \"ship_to_location_code\": \"\",\n \"tax_amount\": \"\",\n \"gross_amount\": \"\",\n \"status\": \"\",\n \"is_deleted\": \"\",\n \"deleted_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"custom_text_1\": \"\",\n \"custom_text_2\": \"\",\n \"custom_text_3\": \"\",\n \"custom_text_4\": \"\",\n \"custom_text_5\": \"\",\n \"custom_text_6\": \"\",\n \"custom_text_7\": \"\",\n \"custom_text_8\": \"\",\n \"custom_text_9\": \"\",\n \"custom_text_10\": \"\",\n \"custom_text_11\": \"\",\n \"custom_text_12\": \"\",\n \"custom_text_13\": \"\",\n \"custom_text_14\": \"\",\n \"custom_text_15\": \"\",\n \"custom_number_1\": \"\",\n \"custom_number_2\": \"\",\n \"custom_number_3\": \"\",\n \"custom_number_4\": \"\",\n \"custom_number_5\": \"\",\n \"custom_number_6\": \"\",\n \"custom_number_7\": \"\",\n \"custom_number_8\": \"\",\n \"custom_number_9\": \"\",\n \"custom_number_10\": \"\",\n \"custom_date_1\": \"\",\n \"custom_date_2\": \"\",\n \"custom_date_3\": \"\",\n \"custom_date_4\": \"\",\n \"custom_date_5\": \"\",\n \"custom_date_6\": \"\",\n \"custom_date_7\": \"\",\n \"custom_date_8\": \"\",\n \"custom_date_9\": \"\",\n \"custom_date_10\": \"\"\n }\n]", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Purchase order lines processed successfully\",\n \"linesInserted\": 100\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "53d43ddd-cfb6-4647-9ac2-52b9014bc963", "name": "Bad request - validation error", "originalRequest": { "url": { "path": [ "v1", "purchaseorderline" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "full_load", "value": "false" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "[\n {\n \"po_number\": \"\",\n \"po_line_number\": \"\",\n \"source_document_id\": \"\",\n \"source_line_id\": \"\",\n \"quantity\": \"\",\n \"unit_price\": \"\",\n \"net_amount\": \"\",\n \"id\": \"\",\n \"line_type\": \"\",\n \"product_code_1\": \"\",\n \"product_name\": \"\",\n \"product_code_2\": \"\",\n \"unspsc_code\": \"\",\n \"description\": \"\",\n \"requester\": \"\",\n \"buyer\": \"\",\n \"unit_of_measure\": \"\",\n \"currency_code\": \"\",\n \"expected_delivery_date\": \"\",\n \"ship_to_location_code\": \"\",\n \"tax_amount\": \"\",\n \"gross_amount\": \"\",\n \"status\": \"\",\n \"is_deleted\": \"\",\n \"deleted_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"custom_text_1\": \"\",\n \"custom_text_2\": \"\",\n \"custom_text_3\": \"\",\n \"custom_text_4\": \"\",\n \"custom_text_5\": \"\",\n \"custom_text_6\": \"\",\n \"custom_text_7\": \"\",\n \"custom_text_8\": \"\",\n \"custom_text_9\": \"\",\n \"custom_text_10\": \"\",\n \"custom_text_11\": \"\",\n \"custom_text_12\": \"\",\n \"custom_text_13\": \"\",\n \"custom_text_14\": \"\",\n \"custom_text_15\": \"\",\n \"custom_number_1\": \"\",\n \"custom_number_2\": \"\",\n \"custom_number_3\": \"\",\n \"custom_number_4\": \"\",\n \"custom_number_5\": \"\",\n \"custom_number_6\": \"\",\n \"custom_number_7\": \"\",\n \"custom_number_8\": \"\",\n \"custom_number_9\": \"\",\n \"custom_number_10\": \"\",\n \"custom_date_1\": \"\",\n \"custom_date_2\": \"\",\n \"custom_date_3\": \"\",\n \"custom_date_4\": \"\",\n \"custom_date_5\": \"\",\n \"custom_date_6\": \"\",\n \"custom_date_7\": \"\",\n \"custom_date_8\": \"\",\n \"custom_date_9\": \"\",\n \"custom_date_10\": \"\"\n },\n {\n \"po_number\": \"\",\n \"po_line_number\": \"\",\n \"source_document_id\": \"\",\n \"source_line_id\": \"\",\n \"quantity\": \"\",\n \"unit_price\": \"\",\n \"net_amount\": \"\",\n \"id\": \"\",\n \"line_type\": \"\",\n \"product_code_1\": \"\",\n \"product_name\": \"\",\n \"product_code_2\": \"\",\n \"unspsc_code\": \"\",\n \"description\": \"\",\n \"requester\": \"\",\n \"buyer\": \"\",\n \"unit_of_measure\": \"\",\n \"currency_code\": \"\",\n \"expected_delivery_date\": \"\",\n \"ship_to_location_code\": \"\",\n \"tax_amount\": \"\",\n \"gross_amount\": \"\",\n \"status\": \"\",\n \"is_deleted\": \"\",\n \"deleted_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"custom_text_1\": \"\",\n \"custom_text_2\": \"\",\n \"custom_text_3\": \"\",\n \"custom_text_4\": \"\",\n \"custom_text_5\": \"\",\n \"custom_text_6\": \"\",\n \"custom_text_7\": \"\",\n \"custom_text_8\": \"\",\n \"custom_text_9\": \"\",\n \"custom_text_10\": \"\",\n \"custom_text_11\": \"\",\n \"custom_text_12\": \"\",\n \"custom_text_13\": \"\",\n \"custom_text_14\": \"\",\n \"custom_text_15\": \"\",\n \"custom_number_1\": \"\",\n \"custom_number_2\": \"\",\n \"custom_number_3\": \"\",\n \"custom_number_4\": \"\",\n \"custom_number_5\": \"\",\n \"custom_number_6\": \"\",\n \"custom_number_7\": \"\",\n \"custom_number_8\": \"\",\n \"custom_number_9\": \"\",\n \"custom_number_10\": \"\",\n \"custom_date_1\": \"\",\n \"custom_date_2\": \"\",\n \"custom_date_3\": \"\",\n \"custom_date_4\": \"\",\n \"custom_date_5\": \"\",\n \"custom_date_6\": \"\",\n \"custom_date_7\": \"\",\n \"custom_date_8\": \"\",\n \"custom_date_9\": \"\",\n \"custom_date_10\": \"\"\n }\n]", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Line at index 0 is missing or has invalid \\\"po_number\\\" (must be non-empty string).\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f3a53181-bb3e-4dfc-ae72-0ec411dd463f", "name": "Unauthorized - invalid or missing API key", "originalRequest": { "url": { "path": [ "v1", "purchaseorderline" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "full_load", "value": "false" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "[\n {\n \"po_number\": \"\",\n \"po_line_number\": \"\",\n \"source_document_id\": \"\",\n \"source_line_id\": \"\",\n \"quantity\": \"\",\n \"unit_price\": \"\",\n \"net_amount\": \"\",\n \"id\": \"\",\n \"line_type\": \"\",\n \"product_code_1\": \"\",\n \"product_name\": \"\",\n \"product_code_2\": \"\",\n \"unspsc_code\": \"\",\n \"description\": \"\",\n \"requester\": \"\",\n \"buyer\": \"\",\n \"unit_of_measure\": \"\",\n \"currency_code\": \"\",\n \"expected_delivery_date\": \"\",\n \"ship_to_location_code\": \"\",\n \"tax_amount\": \"\",\n \"gross_amount\": \"\",\n \"status\": \"\",\n \"is_deleted\": \"\",\n \"deleted_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"custom_text_1\": \"\",\n \"custom_text_2\": \"\",\n \"custom_text_3\": \"\",\n \"custom_text_4\": \"\",\n \"custom_text_5\": \"\",\n \"custom_text_6\": \"\",\n \"custom_text_7\": \"\",\n \"custom_text_8\": \"\",\n \"custom_text_9\": \"\",\n \"custom_text_10\": \"\",\n \"custom_text_11\": \"\",\n \"custom_text_12\": \"\",\n \"custom_text_13\": \"\",\n \"custom_text_14\": \"\",\n \"custom_text_15\": \"\",\n \"custom_number_1\": \"\",\n \"custom_number_2\": \"\",\n \"custom_number_3\": \"\",\n \"custom_number_4\": \"\",\n \"custom_number_5\": \"\",\n \"custom_number_6\": \"\",\n \"custom_number_7\": \"\",\n \"custom_number_8\": \"\",\n \"custom_number_9\": \"\",\n \"custom_number_10\": \"\",\n \"custom_date_1\": \"\",\n \"custom_date_2\": \"\",\n \"custom_date_3\": \"\",\n \"custom_date_4\": \"\",\n \"custom_date_5\": \"\",\n \"custom_date_6\": \"\",\n \"custom_date_7\": \"\",\n \"custom_date_8\": \"\",\n \"custom_date_9\": \"\",\n \"custom_date_10\": \"\"\n },\n {\n \"po_number\": \"\",\n \"po_line_number\": \"\",\n \"source_document_id\": \"\",\n \"source_line_id\": \"\",\n \"quantity\": \"\",\n \"unit_price\": \"\",\n \"net_amount\": \"\",\n \"id\": \"\",\n \"line_type\": \"\",\n \"product_code_1\": \"\",\n \"product_name\": \"\",\n \"product_code_2\": \"\",\n \"unspsc_code\": \"\",\n \"description\": \"\",\n \"requester\": \"\",\n \"buyer\": \"\",\n \"unit_of_measure\": \"\",\n \"currency_code\": \"\",\n \"expected_delivery_date\": \"\",\n \"ship_to_location_code\": \"\",\n \"tax_amount\": \"\",\n \"gross_amount\": \"\",\n \"status\": \"\",\n \"is_deleted\": \"\",\n \"deleted_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"custom_text_1\": \"\",\n \"custom_text_2\": \"\",\n \"custom_text_3\": \"\",\n \"custom_text_4\": \"\",\n \"custom_text_5\": \"\",\n \"custom_text_6\": \"\",\n \"custom_text_7\": \"\",\n \"custom_text_8\": \"\",\n \"custom_text_9\": \"\",\n \"custom_text_10\": \"\",\n \"custom_text_11\": \"\",\n \"custom_text_12\": \"\",\n \"custom_text_13\": \"\",\n \"custom_text_14\": \"\",\n \"custom_text_15\": \"\",\n \"custom_number_1\": \"\",\n \"custom_number_2\": \"\",\n \"custom_number_3\": \"\",\n \"custom_number_4\": \"\",\n \"custom_number_5\": \"\",\n \"custom_number_6\": \"\",\n \"custom_number_7\": \"\",\n \"custom_number_8\": \"\",\n \"custom_number_9\": \"\",\n \"custom_number_10\": \"\",\n \"custom_date_1\": \"\",\n \"custom_date_2\": \"\",\n \"custom_date_3\": \"\",\n \"custom_date_4\": \"\",\n \"custom_date_5\": \"\",\n \"custom_date_6\": \"\",\n \"custom_date_7\": \"\",\n \"custom_date_8\": \"\",\n \"custom_date_9\": \"\",\n \"custom_date_10\": \"\"\n }\n]", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"string\",\n \"code\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fbb9f934-6639-4011-b4d6-92d1c5c431ac", "name": "Forbidden - insufficient permissions", "originalRequest": { "url": { "path": [ "v1", "purchaseorderline" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "full_load", "value": "false" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "[\n {\n \"po_number\": \"\",\n \"po_line_number\": \"\",\n \"source_document_id\": \"\",\n \"source_line_id\": \"\",\n \"quantity\": \"\",\n \"unit_price\": \"\",\n \"net_amount\": \"\",\n \"id\": \"\",\n \"line_type\": \"\",\n \"product_code_1\": \"\",\n \"product_name\": \"\",\n \"product_code_2\": \"\",\n \"unspsc_code\": \"\",\n \"description\": \"\",\n \"requester\": \"\",\n \"buyer\": \"\",\n \"unit_of_measure\": \"\",\n \"currency_code\": \"\",\n \"expected_delivery_date\": \"\",\n \"ship_to_location_code\": \"\",\n \"tax_amount\": \"\",\n \"gross_amount\": \"\",\n \"status\": \"\",\n \"is_deleted\": \"\",\n \"deleted_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"custom_text_1\": \"\",\n \"custom_text_2\": \"\",\n \"custom_text_3\": \"\",\n \"custom_text_4\": \"\",\n \"custom_text_5\": \"\",\n \"custom_text_6\": \"\",\n \"custom_text_7\": \"\",\n \"custom_text_8\": \"\",\n \"custom_text_9\": \"\",\n \"custom_text_10\": \"\",\n \"custom_text_11\": \"\",\n \"custom_text_12\": \"\",\n \"custom_text_13\": \"\",\n \"custom_text_14\": \"\",\n \"custom_text_15\": \"\",\n \"custom_number_1\": \"\",\n \"custom_number_2\": \"\",\n \"custom_number_3\": \"\",\n \"custom_number_4\": \"\",\n \"custom_number_5\": \"\",\n \"custom_number_6\": \"\",\n \"custom_number_7\": \"\",\n \"custom_number_8\": \"\",\n \"custom_number_9\": \"\",\n \"custom_number_10\": \"\",\n \"custom_date_1\": \"\",\n \"custom_date_2\": \"\",\n \"custom_date_3\": \"\",\n \"custom_date_4\": \"\",\n \"custom_date_5\": \"\",\n \"custom_date_6\": \"\",\n \"custom_date_7\": \"\",\n \"custom_date_8\": \"\",\n \"custom_date_9\": \"\",\n \"custom_date_10\": \"\"\n },\n {\n \"po_number\": \"\",\n \"po_line_number\": \"\",\n \"source_document_id\": \"\",\n \"source_line_id\": \"\",\n \"quantity\": \"\",\n \"unit_price\": \"\",\n \"net_amount\": \"\",\n \"id\": \"\",\n \"line_type\": \"\",\n \"product_code_1\": \"\",\n \"product_name\": \"\",\n \"product_code_2\": \"\",\n \"unspsc_code\": \"\",\n \"description\": \"\",\n \"requester\": \"\",\n \"buyer\": \"\",\n \"unit_of_measure\": \"\",\n \"currency_code\": \"\",\n \"expected_delivery_date\": \"\",\n \"ship_to_location_code\": \"\",\n \"tax_amount\": \"\",\n \"gross_amount\": \"\",\n \"status\": \"\",\n \"is_deleted\": \"\",\n \"deleted_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"custom_text_1\": \"\",\n \"custom_text_2\": \"\",\n \"custom_text_3\": \"\",\n \"custom_text_4\": \"\",\n \"custom_text_5\": \"\",\n \"custom_text_6\": \"\",\n \"custom_text_7\": \"\",\n \"custom_text_8\": \"\",\n \"custom_text_9\": \"\",\n \"custom_text_10\": \"\",\n \"custom_text_11\": \"\",\n \"custom_text_12\": \"\",\n \"custom_text_13\": \"\",\n \"custom_text_14\": \"\",\n \"custom_text_15\": \"\",\n \"custom_number_1\": \"\",\n \"custom_number_2\": \"\",\n \"custom_number_3\": \"\",\n \"custom_number_4\": \"\",\n \"custom_number_5\": \"\",\n \"custom_number_6\": \"\",\n \"custom_number_7\": \"\",\n \"custom_number_8\": \"\",\n \"custom_number_9\": \"\",\n \"custom_number_10\": \"\",\n \"custom_date_1\": \"\",\n \"custom_date_2\": \"\",\n \"custom_date_3\": \"\",\n \"custom_date_4\": \"\",\n \"custom_date_5\": \"\",\n \"custom_date_6\": \"\",\n \"custom_date_7\": \"\",\n \"custom_date_8\": \"\",\n \"custom_date_9\": \"\",\n \"custom_date_10\": \"\"\n }\n]", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"Forbidden\",\n \"message\": \"API user does not have required permissions: POST_PURCHASEORDER, POST_DATA\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "75c81a21-5e09-4c2a-8b8a-c80ec2932f28", "name": "Internal server error", "originalRequest": { "url": { "path": [ "v1", "purchaseorderline" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "full_load", "value": "false" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "[\n {\n \"po_number\": \"\",\n \"po_line_number\": \"\",\n \"source_document_id\": \"\",\n \"source_line_id\": \"\",\n \"quantity\": \"\",\n \"unit_price\": \"\",\n \"net_amount\": \"\",\n \"id\": \"\",\n \"line_type\": \"\",\n \"product_code_1\": \"\",\n \"product_name\": \"\",\n \"product_code_2\": \"\",\n \"unspsc_code\": \"\",\n \"description\": \"\",\n \"requester\": \"\",\n \"buyer\": \"\",\n \"unit_of_measure\": \"\",\n \"currency_code\": \"\",\n \"expected_delivery_date\": \"\",\n \"ship_to_location_code\": \"\",\n \"tax_amount\": \"\",\n \"gross_amount\": \"\",\n \"status\": \"\",\n \"is_deleted\": \"\",\n \"deleted_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"custom_text_1\": \"\",\n \"custom_text_2\": \"\",\n \"custom_text_3\": \"\",\n \"custom_text_4\": \"\",\n \"custom_text_5\": \"\",\n \"custom_text_6\": \"\",\n \"custom_text_7\": \"\",\n \"custom_text_8\": \"\",\n \"custom_text_9\": \"\",\n \"custom_text_10\": \"\",\n \"custom_text_11\": \"\",\n \"custom_text_12\": \"\",\n \"custom_text_13\": \"\",\n \"custom_text_14\": \"\",\n \"custom_text_15\": \"\",\n \"custom_number_1\": \"\",\n \"custom_number_2\": \"\",\n \"custom_number_3\": \"\",\n \"custom_number_4\": \"\",\n \"custom_number_5\": \"\",\n \"custom_number_6\": \"\",\n \"custom_number_7\": \"\",\n \"custom_number_8\": \"\",\n \"custom_number_9\": \"\",\n \"custom_number_10\": \"\",\n \"custom_date_1\": \"\",\n \"custom_date_2\": \"\",\n \"custom_date_3\": \"\",\n \"custom_date_4\": \"\",\n \"custom_date_5\": \"\",\n \"custom_date_6\": \"\",\n \"custom_date_7\": \"\",\n \"custom_date_8\": \"\",\n \"custom_date_9\": \"\",\n \"custom_date_10\": \"\"\n },\n {\n \"po_number\": \"\",\n \"po_line_number\": \"\",\n \"source_document_id\": \"\",\n \"source_line_id\": \"\",\n \"quantity\": \"\",\n \"unit_price\": \"\",\n \"net_amount\": \"\",\n \"id\": \"\",\n \"line_type\": \"\",\n \"product_code_1\": \"\",\n \"product_name\": \"\",\n \"product_code_2\": \"\",\n \"unspsc_code\": \"\",\n \"description\": \"\",\n \"requester\": \"\",\n \"buyer\": \"\",\n \"unit_of_measure\": \"\",\n \"currency_code\": \"\",\n \"expected_delivery_date\": \"\",\n \"ship_to_location_code\": \"\",\n \"tax_amount\": \"\",\n \"gross_amount\": \"\",\n \"status\": \"\",\n \"is_deleted\": \"\",\n \"deleted_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"custom_text_1\": \"\",\n \"custom_text_2\": \"\",\n \"custom_text_3\": \"\",\n \"custom_text_4\": \"\",\n \"custom_text_5\": \"\",\n \"custom_text_6\": \"\",\n \"custom_text_7\": \"\",\n \"custom_text_8\": \"\",\n \"custom_text_9\": \"\",\n \"custom_text_10\": \"\",\n \"custom_text_11\": \"\",\n \"custom_text_12\": \"\",\n \"custom_text_13\": \"\",\n \"custom_text_14\": \"\",\n \"custom_text_15\": \"\",\n \"custom_number_1\": \"\",\n \"custom_number_2\": \"\",\n \"custom_number_3\": \"\",\n \"custom_number_4\": \"\",\n \"custom_number_5\": \"\",\n \"custom_number_6\": \"\",\n \"custom_number_7\": \"\",\n \"custom_number_8\": \"\",\n \"custom_number_9\": \"\",\n \"custom_number_10\": \"\",\n \"custom_date_1\": \"\",\n \"custom_date_2\": \"\",\n \"custom_date_3\": \"\",\n \"custom_date_4\": \"\",\n \"custom_date_5\": \"\",\n \"custom_date_6\": \"\",\n \"custom_date_7\": \"\",\n \"custom_date_8\": \"\",\n \"custom_date_9\": \"\",\n \"custom_date_10\": \"\"\n }\n]", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"string\",\n \"code\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "902bad7b-bbef-429b-9418-7c0168b459f3", "name": "Delete purchase order lines", "request": { "name": "Delete purchase order lines", "description": { "content": "\nSoft-delete purchase order lines based on filter criteria. Sets `is_deleted = true`\nand `deleted_at = NOW()`.\n\n**Cascade**: matched lines also soft-delete their child purchase_order_receipt\nrows (via `source_line_id`).\n\n**No `action` field**: previous versions accepted `action: 'delete' | 'deactivate'`.\nThat parameter is no longer supported — the only supported behavior is\nsoft-delete. Sending `action` in the request body returns 400.\n\n**Filter parameters** array — each entry runs as one independent UPDATE; fields\nwithin an entry combine with AND. Maximum 50 filter entries per request.\n ", "type": "text/plain" }, "url": { "path": [ "v1", "purchaseorderline" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"parameters\": [\n {\n \"id\": \"\",\n \"po_number\": \"\",\n \"po_line_number\": \"\",\n \"source_line_id\": \"\",\n \"source_document_id\": \"\",\n \"created_before_date\": \"\",\n \"created_after_date\": \"\",\n \"updated_before_date\": \"\",\n \"updated_after_date\": \"\"\n },\n {\n \"id\": \"\",\n \"po_number\": \"\",\n \"po_line_number\": \"\",\n \"source_line_id\": \"\",\n \"source_document_id\": \"\",\n \"created_before_date\": \"\",\n \"created_after_date\": \"\",\n \"updated_before_date\": \"\",\n \"updated_after_date\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "ca609956-ac6e-435f-9716-18f5211ea3a3", "name": "Purchase order lines soft-deleted successfully (receipts cascaded)", "originalRequest": { "url": { "path": [ "v1", "purchaseorderline" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"parameters\": [\n {\n \"id\": \"\",\n \"po_number\": \"\",\n \"po_line_number\": \"\",\n \"source_line_id\": \"\",\n \"source_document_id\": \"\",\n \"created_before_date\": \"\",\n \"created_after_date\": \"\",\n \"updated_before_date\": \"\",\n \"updated_after_date\": \"\"\n },\n {\n \"id\": \"\",\n \"po_number\": \"\",\n \"po_line_number\": \"\",\n \"source_line_id\": \"\",\n \"source_document_id\": \"\",\n \"created_before_date\": \"\",\n \"created_after_date\": \"\",\n \"updated_before_date\": \"\",\n \"updated_after_date\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"15 purchase order line(s) soft-deleted successfully (receipts cascaded).\",\n \"lineIds\": [\n \"d94b6f20-7581-3bc3-1128-711111754660\",\n \"e8d021a3-2df0-af35-caff-5fca1f2fa51d\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "42327c82-a5ca-45f5-804b-31cb7dc819d5", "name": "Bad request - legacy action field present, or missing parameters", "originalRequest": { "url": { "path": [ "v1", "purchaseorderline" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"parameters\": [\n {\n \"id\": \"\",\n \"po_number\": \"\",\n \"po_line_number\": \"\",\n \"source_line_id\": \"\",\n \"source_document_id\": \"\",\n \"created_before_date\": \"\",\n \"created_after_date\": \"\",\n \"updated_before_date\": \"\",\n \"updated_after_date\": \"\"\n },\n {\n \"id\": \"\",\n \"po_number\": \"\",\n \"po_line_number\": \"\",\n \"source_line_id\": \"\",\n \"source_document_id\": \"\",\n \"created_before_date\": \"\",\n \"created_after_date\": \"\",\n \"updated_before_date\": \"\",\n \"updated_after_date\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"The \\\"action\\\" field is no longer accepted on /purchaseorderline. DELETE now always soft-deletes (is_deleted = true). Remove \\\"action\\\" from your request body.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "29e762cc-c236-48da-b66e-249cbed1a407", "name": "Unauthorized - invalid or missing API key", "originalRequest": { "url": { "path": [ "v1", "purchaseorderline" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"parameters\": [\n {\n \"id\": \"\",\n \"po_number\": \"\",\n \"po_line_number\": \"\",\n \"source_line_id\": \"\",\n \"source_document_id\": \"\",\n \"created_before_date\": \"\",\n \"created_after_date\": \"\",\n \"updated_before_date\": \"\",\n \"updated_after_date\": \"\"\n },\n {\n \"id\": \"\",\n \"po_number\": \"\",\n \"po_line_number\": \"\",\n \"source_line_id\": \"\",\n \"source_document_id\": \"\",\n \"created_before_date\": \"\",\n \"created_after_date\": \"\",\n \"updated_before_date\": \"\",\n \"updated_after_date\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"string\",\n \"code\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "deeef686-3059-46fe-b914-1b70e97b43e1", "name": "Forbidden - insufficient permissions", "originalRequest": { "url": { "path": [ "v1", "purchaseorderline" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"parameters\": [\n {\n \"id\": \"\",\n \"po_number\": \"\",\n \"po_line_number\": \"\",\n \"source_line_id\": \"\",\n \"source_document_id\": \"\",\n \"created_before_date\": \"\",\n \"created_after_date\": \"\",\n \"updated_before_date\": \"\",\n \"updated_after_date\": \"\"\n },\n {\n \"id\": \"\",\n \"po_number\": \"\",\n \"po_line_number\": \"\",\n \"source_line_id\": \"\",\n \"source_document_id\": \"\",\n \"created_before_date\": \"\",\n \"created_after_date\": \"\",\n \"updated_before_date\": \"\",\n \"updated_after_date\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"Forbidden\",\n \"message\": \"API user does not have required permissions: POST_PURCHASEORDER, POST_DATA\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a257d83e-3c7a-431b-8b36-ce74bb383073", "name": "No matching purchase order lines found", "originalRequest": { "url": { "path": [ "v1", "purchaseorderline" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"parameters\": [\n {\n \"id\": \"\",\n \"po_number\": \"\",\n \"po_line_number\": \"\",\n \"source_line_id\": \"\",\n \"source_document_id\": \"\",\n \"created_before_date\": \"\",\n \"created_after_date\": \"\",\n \"updated_before_date\": \"\",\n \"updated_after_date\": \"\"\n },\n {\n \"id\": \"\",\n \"po_number\": \"\",\n \"po_line_number\": \"\",\n \"source_line_id\": \"\",\n \"source_document_id\": \"\",\n \"created_before_date\": \"\",\n \"created_after_date\": \"\",\n \"updated_before_date\": \"\",\n \"updated_after_date\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"No matching purchase order lines found.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7e459e85-0deb-4c31-a4a1-a4c45d18f995", "name": "Internal server error", "originalRequest": { "url": { "path": [ "v1", "purchaseorderline" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"parameters\": [\n {\n \"id\": \"\",\n \"po_number\": \"\",\n \"po_line_number\": \"\",\n \"source_line_id\": \"\",\n \"source_document_id\": \"\",\n \"created_before_date\": \"\",\n \"created_after_date\": \"\",\n \"updated_before_date\": \"\",\n \"updated_after_date\": \"\"\n },\n {\n \"id\": \"\",\n \"po_number\": \"\",\n \"po_line_number\": \"\",\n \"source_line_id\": \"\",\n \"source_document_id\": \"\",\n \"created_before_date\": \"\",\n \"created_after_date\": \"\",\n \"updated_before_date\": \"\",\n \"updated_after_date\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"string\",\n \"code\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "5c331b76-49e0-4299-a448-c972d2e9b4a6", "name": "Receipt", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "29ad7cfd-56fb-47ed-b470-159815d59824", "name": "List purchase order receipts", "request": { "name": "List purchase order receipts", "description": { "content": "Returns a paginated list of purchase order receipt records. Only non-deleted records are returned.", "type": "text/plain" }, "url": { "path": [ "v1", "receipt" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "key": "page", "value": "1", "description": "Page number for pagination" }, { "disabled": true, "key": "limit", "value": "1000", "description": "Number of records per page (max 1000)" }, { "disabled": true, "key": "po_number", "value": "", "description": "Filter by PO number (exact match)" }, { "disabled": true, "key": "po_line_number", "value": "", "description": "Filter by PO line number (exact match)" }, { "disabled": true, "key": "receipt_line_number", "value": "", "description": "Filter by receipt line number (exact match)" }, { "disabled": true, "key": "receipt_number", "value": "", "description": "Filter by receipt number (exact match)" }, { "disabled": true, "key": "source_document_id", "value": "", "description": "Filter by source document ID (exact match)" }, { "disabled": true, "key": "source_line_id", "value": "", "description": "Filter by source line ID (exact match)" }, { "disabled": true, "key": "source_receipt_line_id", "value": "", "description": "Filter by source receipt line ID (exact match)" }, { "disabled": true, "key": "received_by", "value": "", "description": "Filter by received_by (exact match)" }, { "disabled": true, "key": "receipt_date_before", "value": "", "description": "Receipt date strictly before this timestamp" }, { "disabled": true, "key": "receipt_date_after", "value": "", "description": "Receipt date strictly after this timestamp" }, { "disabled": true, "key": "updated_at_before", "value": "", "description": "Updated_at strictly before this timestamp" }, { "disabled": true, "key": "updated_at_after", "value": "", "description": "Updated_at strictly after this timestamp" }, { "disabled": true, "key": "deleted_at_before", "value": "", "description": "Deleted_at strictly before this timestamp" }, { "disabled": true, "key": "deleted_at_after", "value": "", "description": "Deleted_at strictly after this timestamp" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "6b4e1e93-686b-4bd0-b7c2-a7aa160f31ce", "name": "List of receipts", "originalRequest": { "url": { "path": [ "v1", "receipt" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "limit", "value": "1000" }, { "key": "po_number", "value": "" }, { "key": "po_line_number", "value": "" }, { "key": "receipt_line_number", "value": "" }, { "key": "receipt_number", "value": "" }, { "key": "source_document_id", "value": "" }, { "key": "source_line_id", "value": "" }, { "key": "source_receipt_line_id", "value": "" }, { "key": "received_by", "value": "" }, { "key": "receipt_date_before", "value": "" }, { "key": "receipt_date_after", "value": "" }, { "key": "updated_at_before", "value": "" }, { "key": "updated_at_after", "value": "" }, { "key": "deleted_at_before", "value": "" }, { "key": "deleted_at_after", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"count\": 464,\n \"page\": 1681,\n \"totalPages\": 6842,\n \"receipts\": [\n {\n \"po_number\": \"string\",\n \"po_line_number\": \"string\",\n \"receipt_line_number\": \"string\",\n \"quantity\": 7647.197503720556,\n \"unit_price\": 7896.711375245751,\n \"net_amount\": 3284.581028500848,\n \"source_document_id\": \"string\",\n \"source_line_id\": \"string\",\n \"source_receipt_line_id\": \"string\",\n \"receipt_number\": \"string\",\n \"receipt_date\": \"2009-01-04T03:32:01.355Z\",\n \"tax_amount\": 7297.184686350104,\n \"gross_amount\": 228.06739592083235,\n \"unit_of_measure\": \"string\",\n \"location_code\": \"string\",\n \"received_by\": \"string\",\n \"comments\": \"string\",\n \"custom_text_1\": \"string\",\n \"custom_text_2\": \"string\",\n \"custom_text_3\": \"string\",\n \"custom_text_4\": \"string\",\n \"custom_text_5\": \"string\",\n \"custom_text_6\": \"string\",\n \"custom_text_7\": \"string\",\n \"custom_text_8\": \"string\",\n \"custom_text_9\": \"string\",\n \"custom_text_10\": \"string\",\n \"custom_number_1\": 7009.736309428283,\n \"custom_number_2\": 5842.554526804141,\n \"custom_number_3\": 2135.797761110112,\n \"custom_number_4\": 3779.583662277328,\n \"custom_number_5\": 8423.076749075874,\n \"custom_number_6\": 6090.168219141572,\n \"custom_number_7\": 2119.926515005348,\n \"custom_number_8\": 1126.6483437458264,\n \"custom_number_9\": 7353.110650103585,\n \"custom_number_10\": 760.345535509881,\n \"custom_date_1\": \"1990-07-07\",\n \"custom_date_2\": \"2019-12-27\",\n \"custom_date_3\": \"1996-12-28\",\n \"custom_date_4\": \"1973-06-18\",\n \"custom_date_5\": \"2018-05-26\",\n \"custom_date_6\": \"1948-06-14\",\n \"custom_date_7\": \"1997-08-23\",\n \"custom_date_8\": \"1976-03-17\",\n \"custom_date_9\": \"2020-12-24\",\n \"custom_date_10\": \"1972-08-21\",\n \"is_deleted\": true,\n \"deleted_at\": \"1953-04-24T11:37:13.834Z\",\n \"created_at\": \"2015-10-08T02:52:25.619Z\",\n \"updated_at\": \"2000-04-12T23:12:10.622Z\"\n },\n {\n \"po_number\": \"string\",\n \"po_line_number\": \"string\",\n \"receipt_line_number\": \"string\",\n \"quantity\": 8844.398000984103,\n \"unit_price\": 9861.397925440906,\n \"net_amount\": 6723.488637516095,\n \"source_document_id\": \"string\",\n \"source_line_id\": \"string\",\n \"source_receipt_line_id\": \"string\",\n \"receipt_number\": \"string\",\n \"receipt_date\": \"1971-03-12T23:57:35.168Z\",\n \"tax_amount\": 1723.265801138265,\n \"gross_amount\": 4316.1650920326065,\n \"unit_of_measure\": \"string\",\n \"location_code\": \"string\",\n \"received_by\": \"string\",\n \"comments\": \"string\",\n \"custom_text_1\": \"string\",\n \"custom_text_2\": \"string\",\n \"custom_text_3\": \"string\",\n \"custom_text_4\": \"string\",\n \"custom_text_5\": \"string\",\n \"custom_text_6\": \"string\",\n \"custom_text_7\": \"string\",\n \"custom_text_8\": \"string\",\n \"custom_text_9\": \"string\",\n \"custom_text_10\": \"string\",\n \"custom_number_1\": 1899.7080855323788,\n \"custom_number_2\": 5787.438128872313,\n \"custom_number_3\": 4946.412489627086,\n \"custom_number_4\": 5030.820531438553,\n \"custom_number_5\": 8041.628732612252,\n \"custom_number_6\": 3274.3339166444807,\n \"custom_number_7\": 6119.242941409755,\n \"custom_number_8\": 5303.489067756,\n \"custom_number_9\": 4931.667516399792,\n \"custom_number_10\": 7476.650716510616,\n \"custom_date_1\": \"1949-06-26\",\n \"custom_date_2\": \"2005-04-19\",\n \"custom_date_3\": \"1988-02-25\",\n \"custom_date_4\": \"2011-01-16\",\n \"custom_date_5\": \"1960-11-11\",\n \"custom_date_6\": \"2004-10-13\",\n \"custom_date_7\": \"1993-04-27\",\n \"custom_date_8\": \"1981-04-09\",\n \"custom_date_9\": \"2019-05-30\",\n \"custom_date_10\": \"1993-06-08\",\n \"is_deleted\": true,\n \"deleted_at\": \"2023-11-09T18:14:29.016Z\",\n \"created_at\": \"1952-08-12T06:53:39.897Z\",\n \"updated_at\": \"1994-03-01T05:25:52.769Z\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "317565c2-d665-422d-858f-1f613231dfa2", "name": "Unauthorized - invalid or missing API key", "originalRequest": { "url": { "path": [ "v1", "receipt" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "limit", "value": "1000" }, { "key": "po_number", "value": "" }, { "key": "po_line_number", "value": "" }, { "key": "receipt_line_number", "value": "" }, { "key": "receipt_number", "value": "" }, { "key": "source_document_id", "value": "" }, { "key": "source_line_id", "value": "" }, { "key": "source_receipt_line_id", "value": "" }, { "key": "received_by", "value": "" }, { "key": "receipt_date_before", "value": "" }, { "key": "receipt_date_after", "value": "" }, { "key": "updated_at_before", "value": "" }, { "key": "updated_at_after", "value": "" }, { "key": "deleted_at_before", "value": "" }, { "key": "deleted_at_after", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"Unauthorized\",\n \"message\": \"API key is required\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1a6f781e-adb2-4d0c-86c5-74e1f38fee88", "name": "Forbidden - insufficient permissions", "originalRequest": { "url": { "path": [ "v1", "receipt" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "limit", "value": "1000" }, { "key": "po_number", "value": "" }, { "key": "po_line_number", "value": "" }, { "key": "receipt_line_number", "value": "" }, { "key": "receipt_number", "value": "" }, { "key": "source_document_id", "value": "" }, { "key": "source_line_id", "value": "" }, { "key": "source_receipt_line_id", "value": "" }, { "key": "received_by", "value": "" }, { "key": "receipt_date_before", "value": "" }, { "key": "receipt_date_after", "value": "" }, { "key": "updated_at_before", "value": "" }, { "key": "updated_at_after", "value": "" }, { "key": "deleted_at_before", "value": "" }, { "key": "deleted_at_after", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"Forbidden\",\n \"message\": \"API user does not have required permissions: READ_RECEIPT, READ_DATA\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5e26b589-421e-4558-b6c3-c6b927bac7c6", "name": "Internal server error", "originalRequest": { "url": { "path": [ "v1", "receipt" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "limit", "value": "1000" }, { "key": "po_number", "value": "" }, { "key": "po_line_number", "value": "" }, { "key": "receipt_line_number", "value": "" }, { "key": "receipt_number", "value": "" }, { "key": "source_document_id", "value": "" }, { "key": "source_line_id", "value": "" }, { "key": "source_receipt_line_id", "value": "" }, { "key": "received_by", "value": "" }, { "key": "receipt_date_before", "value": "" }, { "key": "receipt_date_after", "value": "" }, { "key": "updated_at_before", "value": "" }, { "key": "updated_at_after", "value": "" }, { "key": "deleted_at_before", "value": "" }, { "key": "deleted_at_after", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"Internal server error\",\n \"message\": \"Database query failed\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "26eb7bba-0bfb-4e28-bd89-b3cd6029e436", "name": "Upsert receipts", "request": { "name": "Upsert receipts", "description": { "content": "\nImport or update purchase order receipt records. Supports both incremental updates and full data replacement.\n\n**Upsert Key**: source_receipt_line_id (`ON CONFLICT` target)\n\n**full_load Behavior**:\n- **false** (default): Incremental upsert — updates existing receipts (matched by source_receipt_line_id), inserts new ones\n- **true**: Full replacement — deletes ALL existing receipts for the customer, then inserts new data\n\n**Required Fields**: po_number, po_line_number, receipt_line_number, quantity, unit_price, net_amount, source_document_id, source_line_id, source_receipt_line_id\n\n**Referential integrity**: every `source_line_id` must reference an existing purchase_order_line row, or the request is rejected with 400.\n\n**Limits**: maximum 1000 receipts per request.\n ", "type": "text/plain" }, "url": { "path": [ "v1", "receipt" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "key": "full_load", "value": "false", "description": "If true, deletes ALL existing receipts before inserting new data" } ], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "[\n {\n \"po_number\": \"\",\n \"po_line_number\": \"\",\n \"receipt_line_number\": \"\",\n \"quantity\": \"\",\n \"unit_price\": \"\",\n \"net_amount\": \"\",\n \"source_document_id\": \"\",\n \"source_line_id\": \"\",\n \"source_receipt_line_id\": \"\",\n \"receipt_number\": \"\",\n \"receipt_date\": \"\",\n \"tax_amount\": \"\",\n \"gross_amount\": \"\",\n \"unit_of_measure\": \"\",\n \"location_code\": \"\",\n \"received_by\": \"\",\n \"comments\": \"\",\n \"custom_text_1\": \"\",\n \"custom_text_2\": \"\",\n \"custom_text_3\": \"\",\n \"custom_text_4\": \"\",\n \"custom_text_5\": \"\",\n \"custom_text_6\": \"\",\n \"custom_text_7\": \"\",\n \"custom_text_8\": \"\",\n \"custom_text_9\": \"\",\n \"custom_text_10\": \"\",\n \"custom_number_1\": \"\",\n \"custom_number_2\": \"\",\n \"custom_number_3\": \"\",\n \"custom_number_4\": \"\",\n \"custom_number_5\": \"\",\n \"custom_number_6\": \"\",\n \"custom_number_7\": \"\",\n \"custom_number_8\": \"\",\n \"custom_number_9\": \"\",\n \"custom_number_10\": \"\",\n \"custom_date_1\": \"\",\n \"custom_date_2\": \"\",\n \"custom_date_3\": \"\",\n \"custom_date_4\": \"\",\n \"custom_date_5\": \"\",\n \"custom_date_6\": \"\",\n \"custom_date_7\": \"\",\n \"custom_date_8\": \"\",\n \"custom_date_9\": \"\",\n \"custom_date_10\": \"\",\n \"is_deleted\": \"\",\n \"deleted_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n },\n {\n \"po_number\": \"\",\n \"po_line_number\": \"\",\n \"receipt_line_number\": \"\",\n \"quantity\": \"\",\n \"unit_price\": \"\",\n \"net_amount\": \"\",\n \"source_document_id\": \"\",\n \"source_line_id\": \"\",\n \"source_receipt_line_id\": \"\",\n \"receipt_number\": \"\",\n \"receipt_date\": \"\",\n \"tax_amount\": \"\",\n \"gross_amount\": \"\",\n \"unit_of_measure\": \"\",\n \"location_code\": \"\",\n \"received_by\": \"\",\n \"comments\": \"\",\n \"custom_text_1\": \"\",\n \"custom_text_2\": \"\",\n \"custom_text_3\": \"\",\n \"custom_text_4\": \"\",\n \"custom_text_5\": \"\",\n \"custom_text_6\": \"\",\n \"custom_text_7\": \"\",\n \"custom_text_8\": \"\",\n \"custom_text_9\": \"\",\n \"custom_text_10\": \"\",\n \"custom_number_1\": \"\",\n \"custom_number_2\": \"\",\n \"custom_number_3\": \"\",\n \"custom_number_4\": \"\",\n \"custom_number_5\": \"\",\n \"custom_number_6\": \"\",\n \"custom_number_7\": \"\",\n \"custom_number_8\": \"\",\n \"custom_number_9\": \"\",\n \"custom_number_10\": \"\",\n \"custom_date_1\": \"\",\n \"custom_date_2\": \"\",\n \"custom_date_3\": \"\",\n \"custom_date_4\": \"\",\n \"custom_date_5\": \"\",\n \"custom_date_6\": \"\",\n \"custom_date_7\": \"\",\n \"custom_date_8\": \"\",\n \"custom_date_9\": \"\",\n \"custom_date_10\": \"\",\n \"is_deleted\": \"\",\n \"deleted_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n]", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "122c3562-0aca-4480-b857-512f2ef9b709", "name": "Receipts imported successfully", "originalRequest": { "url": { "path": [ "v1", "receipt" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "full_load", "value": "false" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "[\n {\n \"po_number\": \"\",\n \"po_line_number\": \"\",\n \"receipt_line_number\": \"\",\n \"quantity\": \"\",\n \"unit_price\": \"\",\n \"net_amount\": \"\",\n \"source_document_id\": \"\",\n \"source_line_id\": \"\",\n \"source_receipt_line_id\": \"\",\n \"receipt_number\": \"\",\n \"receipt_date\": \"\",\n \"tax_amount\": \"\",\n \"gross_amount\": \"\",\n \"unit_of_measure\": \"\",\n \"location_code\": \"\",\n \"received_by\": \"\",\n \"comments\": \"\",\n \"custom_text_1\": \"\",\n \"custom_text_2\": \"\",\n \"custom_text_3\": \"\",\n \"custom_text_4\": \"\",\n \"custom_text_5\": \"\",\n \"custom_text_6\": \"\",\n \"custom_text_7\": \"\",\n \"custom_text_8\": \"\",\n \"custom_text_9\": \"\",\n \"custom_text_10\": \"\",\n \"custom_number_1\": \"\",\n \"custom_number_2\": \"\",\n \"custom_number_3\": \"\",\n \"custom_number_4\": \"\",\n \"custom_number_5\": \"\",\n \"custom_number_6\": \"\",\n \"custom_number_7\": \"\",\n \"custom_number_8\": \"\",\n \"custom_number_9\": \"\",\n \"custom_number_10\": \"\",\n \"custom_date_1\": \"\",\n \"custom_date_2\": \"\",\n \"custom_date_3\": \"\",\n \"custom_date_4\": \"\",\n \"custom_date_5\": \"\",\n \"custom_date_6\": \"\",\n \"custom_date_7\": \"\",\n \"custom_date_8\": \"\",\n \"custom_date_9\": \"\",\n \"custom_date_10\": \"\",\n \"is_deleted\": \"\",\n \"deleted_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n },\n {\n \"po_number\": \"\",\n \"po_line_number\": \"\",\n \"receipt_line_number\": \"\",\n \"quantity\": \"\",\n \"unit_price\": \"\",\n \"net_amount\": \"\",\n \"source_document_id\": \"\",\n \"source_line_id\": \"\",\n \"source_receipt_line_id\": \"\",\n \"receipt_number\": \"\",\n \"receipt_date\": \"\",\n \"tax_amount\": \"\",\n \"gross_amount\": \"\",\n \"unit_of_measure\": \"\",\n \"location_code\": \"\",\n \"received_by\": \"\",\n \"comments\": \"\",\n \"custom_text_1\": \"\",\n \"custom_text_2\": \"\",\n \"custom_text_3\": \"\",\n \"custom_text_4\": \"\",\n \"custom_text_5\": \"\",\n \"custom_text_6\": \"\",\n \"custom_text_7\": \"\",\n \"custom_text_8\": \"\",\n \"custom_text_9\": \"\",\n \"custom_text_10\": \"\",\n \"custom_number_1\": \"\",\n \"custom_number_2\": \"\",\n \"custom_number_3\": \"\",\n \"custom_number_4\": \"\",\n \"custom_number_5\": \"\",\n \"custom_number_6\": \"\",\n \"custom_number_7\": \"\",\n \"custom_number_8\": \"\",\n \"custom_number_9\": \"\",\n \"custom_number_10\": \"\",\n \"custom_date_1\": \"\",\n \"custom_date_2\": \"\",\n \"custom_date_3\": \"\",\n \"custom_date_4\": \"\",\n \"custom_date_5\": \"\",\n \"custom_date_6\": \"\",\n \"custom_date_7\": \"\",\n \"custom_date_8\": \"\",\n \"custom_date_9\": \"\",\n \"custom_date_10\": \"\",\n \"is_deleted\": \"\",\n \"deleted_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n]", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Receipts imported successfully\",\n \"receiptsInserted\": 50\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8024a3fb-8f4f-446b-9b89-e8ab54de4fbd", "name": "Bad request - validation error", "originalRequest": { "url": { "path": [ "v1", "receipt" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "full_load", "value": "false" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "[\n {\n \"po_number\": \"\",\n \"po_line_number\": \"\",\n \"receipt_line_number\": \"\",\n \"quantity\": \"\",\n \"unit_price\": \"\",\n \"net_amount\": \"\",\n \"source_document_id\": \"\",\n \"source_line_id\": \"\",\n \"source_receipt_line_id\": \"\",\n \"receipt_number\": \"\",\n \"receipt_date\": \"\",\n \"tax_amount\": \"\",\n \"gross_amount\": \"\",\n \"unit_of_measure\": \"\",\n \"location_code\": \"\",\n \"received_by\": \"\",\n \"comments\": \"\",\n \"custom_text_1\": \"\",\n \"custom_text_2\": \"\",\n \"custom_text_3\": \"\",\n \"custom_text_4\": \"\",\n \"custom_text_5\": \"\",\n \"custom_text_6\": \"\",\n \"custom_text_7\": \"\",\n \"custom_text_8\": \"\",\n \"custom_text_9\": \"\",\n \"custom_text_10\": \"\",\n \"custom_number_1\": \"\",\n \"custom_number_2\": \"\",\n \"custom_number_3\": \"\",\n \"custom_number_4\": \"\",\n \"custom_number_5\": \"\",\n \"custom_number_6\": \"\",\n \"custom_number_7\": \"\",\n \"custom_number_8\": \"\",\n \"custom_number_9\": \"\",\n \"custom_number_10\": \"\",\n \"custom_date_1\": \"\",\n \"custom_date_2\": \"\",\n \"custom_date_3\": \"\",\n \"custom_date_4\": \"\",\n \"custom_date_5\": \"\",\n \"custom_date_6\": \"\",\n \"custom_date_7\": \"\",\n \"custom_date_8\": \"\",\n \"custom_date_9\": \"\",\n \"custom_date_10\": \"\",\n \"is_deleted\": \"\",\n \"deleted_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n },\n {\n \"po_number\": \"\",\n \"po_line_number\": \"\",\n \"receipt_line_number\": \"\",\n \"quantity\": \"\",\n \"unit_price\": \"\",\n \"net_amount\": \"\",\n \"source_document_id\": \"\",\n \"source_line_id\": \"\",\n \"source_receipt_line_id\": \"\",\n \"receipt_number\": \"\",\n \"receipt_date\": \"\",\n \"tax_amount\": \"\",\n \"gross_amount\": \"\",\n \"unit_of_measure\": \"\",\n \"location_code\": \"\",\n \"received_by\": \"\",\n \"comments\": \"\",\n \"custom_text_1\": \"\",\n \"custom_text_2\": \"\",\n \"custom_text_3\": \"\",\n \"custom_text_4\": \"\",\n \"custom_text_5\": \"\",\n \"custom_text_6\": \"\",\n \"custom_text_7\": \"\",\n \"custom_text_8\": \"\",\n \"custom_text_9\": \"\",\n \"custom_text_10\": \"\",\n \"custom_number_1\": \"\",\n \"custom_number_2\": \"\",\n \"custom_number_3\": \"\",\n \"custom_number_4\": \"\",\n \"custom_number_5\": \"\",\n \"custom_number_6\": \"\",\n \"custom_number_7\": \"\",\n \"custom_number_8\": \"\",\n \"custom_number_9\": \"\",\n \"custom_number_10\": \"\",\n \"custom_date_1\": \"\",\n \"custom_date_2\": \"\",\n \"custom_date_3\": \"\",\n \"custom_date_4\": \"\",\n \"custom_date_5\": \"\",\n \"custom_date_6\": \"\",\n \"custom_date_7\": \"\",\n \"custom_date_8\": \"\",\n \"custom_date_9\": \"\",\n \"custom_date_10\": \"\",\n \"is_deleted\": \"\",\n \"deleted_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n]", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Receipt at index 0 is missing or has invalid \\\"po_number\\\" (must be non-empty string).\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "68fbe3a5-7ca7-4b97-a228-a2e66364acbc", "name": "Unauthorized - invalid or missing API key", "originalRequest": { "url": { "path": [ "v1", "receipt" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "full_load", "value": "false" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "[\n {\n \"po_number\": \"\",\n \"po_line_number\": \"\",\n \"receipt_line_number\": \"\",\n \"quantity\": \"\",\n \"unit_price\": \"\",\n \"net_amount\": \"\",\n \"source_document_id\": \"\",\n \"source_line_id\": \"\",\n \"source_receipt_line_id\": \"\",\n \"receipt_number\": \"\",\n \"receipt_date\": \"\",\n \"tax_amount\": \"\",\n \"gross_amount\": \"\",\n \"unit_of_measure\": \"\",\n \"location_code\": \"\",\n \"received_by\": \"\",\n \"comments\": \"\",\n \"custom_text_1\": \"\",\n \"custom_text_2\": \"\",\n \"custom_text_3\": \"\",\n \"custom_text_4\": \"\",\n \"custom_text_5\": \"\",\n \"custom_text_6\": \"\",\n \"custom_text_7\": \"\",\n \"custom_text_8\": \"\",\n \"custom_text_9\": \"\",\n \"custom_text_10\": \"\",\n \"custom_number_1\": \"\",\n \"custom_number_2\": \"\",\n \"custom_number_3\": \"\",\n \"custom_number_4\": \"\",\n \"custom_number_5\": \"\",\n \"custom_number_6\": \"\",\n \"custom_number_7\": \"\",\n \"custom_number_8\": \"\",\n \"custom_number_9\": \"\",\n \"custom_number_10\": \"\",\n \"custom_date_1\": \"\",\n \"custom_date_2\": \"\",\n \"custom_date_3\": \"\",\n \"custom_date_4\": \"\",\n \"custom_date_5\": \"\",\n \"custom_date_6\": \"\",\n \"custom_date_7\": \"\",\n \"custom_date_8\": \"\",\n \"custom_date_9\": \"\",\n \"custom_date_10\": \"\",\n \"is_deleted\": \"\",\n \"deleted_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n },\n {\n \"po_number\": \"\",\n \"po_line_number\": \"\",\n \"receipt_line_number\": \"\",\n \"quantity\": \"\",\n \"unit_price\": \"\",\n \"net_amount\": \"\",\n \"source_document_id\": \"\",\n \"source_line_id\": \"\",\n \"source_receipt_line_id\": \"\",\n \"receipt_number\": \"\",\n \"receipt_date\": \"\",\n \"tax_amount\": \"\",\n \"gross_amount\": \"\",\n \"unit_of_measure\": \"\",\n \"location_code\": \"\",\n \"received_by\": \"\",\n \"comments\": \"\",\n \"custom_text_1\": \"\",\n \"custom_text_2\": \"\",\n \"custom_text_3\": \"\",\n \"custom_text_4\": \"\",\n \"custom_text_5\": \"\",\n \"custom_text_6\": \"\",\n \"custom_text_7\": \"\",\n \"custom_text_8\": \"\",\n \"custom_text_9\": \"\",\n \"custom_text_10\": \"\",\n \"custom_number_1\": \"\",\n \"custom_number_2\": \"\",\n \"custom_number_3\": \"\",\n \"custom_number_4\": \"\",\n \"custom_number_5\": \"\",\n \"custom_number_6\": \"\",\n \"custom_number_7\": \"\",\n \"custom_number_8\": \"\",\n \"custom_number_9\": \"\",\n \"custom_number_10\": \"\",\n \"custom_date_1\": \"\",\n \"custom_date_2\": \"\",\n \"custom_date_3\": \"\",\n \"custom_date_4\": \"\",\n \"custom_date_5\": \"\",\n \"custom_date_6\": \"\",\n \"custom_date_7\": \"\",\n \"custom_date_8\": \"\",\n \"custom_date_9\": \"\",\n \"custom_date_10\": \"\",\n \"is_deleted\": \"\",\n \"deleted_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n]", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"string\",\n \"code\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5bc8bdab-bc77-420a-8e29-eaf9a62279c4", "name": "Forbidden - insufficient permissions", "originalRequest": { "url": { "path": [ "v1", "receipt" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "full_load", "value": "false" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "[\n {\n \"po_number\": \"\",\n \"po_line_number\": \"\",\n \"receipt_line_number\": \"\",\n \"quantity\": \"\",\n \"unit_price\": \"\",\n \"net_amount\": \"\",\n \"source_document_id\": \"\",\n \"source_line_id\": \"\",\n \"source_receipt_line_id\": \"\",\n \"receipt_number\": \"\",\n \"receipt_date\": \"\",\n \"tax_amount\": \"\",\n \"gross_amount\": \"\",\n \"unit_of_measure\": \"\",\n \"location_code\": \"\",\n \"received_by\": \"\",\n \"comments\": \"\",\n \"custom_text_1\": \"\",\n \"custom_text_2\": \"\",\n \"custom_text_3\": \"\",\n \"custom_text_4\": \"\",\n \"custom_text_5\": \"\",\n \"custom_text_6\": \"\",\n \"custom_text_7\": \"\",\n \"custom_text_8\": \"\",\n \"custom_text_9\": \"\",\n \"custom_text_10\": \"\",\n \"custom_number_1\": \"\",\n \"custom_number_2\": \"\",\n \"custom_number_3\": \"\",\n \"custom_number_4\": \"\",\n \"custom_number_5\": \"\",\n \"custom_number_6\": \"\",\n \"custom_number_7\": \"\",\n \"custom_number_8\": \"\",\n \"custom_number_9\": \"\",\n \"custom_number_10\": \"\",\n \"custom_date_1\": \"\",\n \"custom_date_2\": \"\",\n \"custom_date_3\": \"\",\n \"custom_date_4\": \"\",\n \"custom_date_5\": \"\",\n \"custom_date_6\": \"\",\n \"custom_date_7\": \"\",\n \"custom_date_8\": \"\",\n \"custom_date_9\": \"\",\n \"custom_date_10\": \"\",\n \"is_deleted\": \"\",\n \"deleted_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n },\n {\n \"po_number\": \"\",\n \"po_line_number\": \"\",\n \"receipt_line_number\": \"\",\n \"quantity\": \"\",\n \"unit_price\": \"\",\n \"net_amount\": \"\",\n \"source_document_id\": \"\",\n \"source_line_id\": \"\",\n \"source_receipt_line_id\": \"\",\n \"receipt_number\": \"\",\n \"receipt_date\": \"\",\n \"tax_amount\": \"\",\n \"gross_amount\": \"\",\n \"unit_of_measure\": \"\",\n \"location_code\": \"\",\n \"received_by\": \"\",\n \"comments\": \"\",\n \"custom_text_1\": \"\",\n \"custom_text_2\": \"\",\n \"custom_text_3\": \"\",\n \"custom_text_4\": \"\",\n \"custom_text_5\": \"\",\n \"custom_text_6\": \"\",\n \"custom_text_7\": \"\",\n \"custom_text_8\": \"\",\n \"custom_text_9\": \"\",\n \"custom_text_10\": \"\",\n \"custom_number_1\": \"\",\n \"custom_number_2\": \"\",\n \"custom_number_3\": \"\",\n \"custom_number_4\": \"\",\n \"custom_number_5\": \"\",\n \"custom_number_6\": \"\",\n \"custom_number_7\": \"\",\n \"custom_number_8\": \"\",\n \"custom_number_9\": \"\",\n \"custom_number_10\": \"\",\n \"custom_date_1\": \"\",\n \"custom_date_2\": \"\",\n \"custom_date_3\": \"\",\n \"custom_date_4\": \"\",\n \"custom_date_5\": \"\",\n \"custom_date_6\": \"\",\n \"custom_date_7\": \"\",\n \"custom_date_8\": \"\",\n \"custom_date_9\": \"\",\n \"custom_date_10\": \"\",\n \"is_deleted\": \"\",\n \"deleted_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n]", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"Forbidden\",\n \"message\": \"API user does not have required permissions: POST_RECEIPT, POST_DATA\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d4eea797-2aa8-481e-82a0-36504bfdf11b", "name": "Internal server error", "originalRequest": { "url": { "path": [ "v1", "receipt" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "full_load", "value": "false" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "[\n {\n \"po_number\": \"\",\n \"po_line_number\": \"\",\n \"receipt_line_number\": \"\",\n \"quantity\": \"\",\n \"unit_price\": \"\",\n \"net_amount\": \"\",\n \"source_document_id\": \"\",\n \"source_line_id\": \"\",\n \"source_receipt_line_id\": \"\",\n \"receipt_number\": \"\",\n \"receipt_date\": \"\",\n \"tax_amount\": \"\",\n \"gross_amount\": \"\",\n \"unit_of_measure\": \"\",\n \"location_code\": \"\",\n \"received_by\": \"\",\n \"comments\": \"\",\n \"custom_text_1\": \"\",\n \"custom_text_2\": \"\",\n \"custom_text_3\": \"\",\n \"custom_text_4\": \"\",\n \"custom_text_5\": \"\",\n \"custom_text_6\": \"\",\n \"custom_text_7\": \"\",\n \"custom_text_8\": \"\",\n \"custom_text_9\": \"\",\n \"custom_text_10\": \"\",\n \"custom_number_1\": \"\",\n \"custom_number_2\": \"\",\n \"custom_number_3\": \"\",\n \"custom_number_4\": \"\",\n \"custom_number_5\": \"\",\n \"custom_number_6\": \"\",\n \"custom_number_7\": \"\",\n \"custom_number_8\": \"\",\n \"custom_number_9\": \"\",\n \"custom_number_10\": \"\",\n \"custom_date_1\": \"\",\n \"custom_date_2\": \"\",\n \"custom_date_3\": \"\",\n \"custom_date_4\": \"\",\n \"custom_date_5\": \"\",\n \"custom_date_6\": \"\",\n \"custom_date_7\": \"\",\n \"custom_date_8\": \"\",\n \"custom_date_9\": \"\",\n \"custom_date_10\": \"\",\n \"is_deleted\": \"\",\n \"deleted_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n },\n {\n \"po_number\": \"\",\n \"po_line_number\": \"\",\n \"receipt_line_number\": \"\",\n \"quantity\": \"\",\n \"unit_price\": \"\",\n \"net_amount\": \"\",\n \"source_document_id\": \"\",\n \"source_line_id\": \"\",\n \"source_receipt_line_id\": \"\",\n \"receipt_number\": \"\",\n \"receipt_date\": \"\",\n \"tax_amount\": \"\",\n \"gross_amount\": \"\",\n \"unit_of_measure\": \"\",\n \"location_code\": \"\",\n \"received_by\": \"\",\n \"comments\": \"\",\n \"custom_text_1\": \"\",\n \"custom_text_2\": \"\",\n \"custom_text_3\": \"\",\n \"custom_text_4\": \"\",\n \"custom_text_5\": \"\",\n \"custom_text_6\": \"\",\n \"custom_text_7\": \"\",\n \"custom_text_8\": \"\",\n \"custom_text_9\": \"\",\n \"custom_text_10\": \"\",\n \"custom_number_1\": \"\",\n \"custom_number_2\": \"\",\n \"custom_number_3\": \"\",\n \"custom_number_4\": \"\",\n \"custom_number_5\": \"\",\n \"custom_number_6\": \"\",\n \"custom_number_7\": \"\",\n \"custom_number_8\": \"\",\n \"custom_number_9\": \"\",\n \"custom_number_10\": \"\",\n \"custom_date_1\": \"\",\n \"custom_date_2\": \"\",\n \"custom_date_3\": \"\",\n \"custom_date_4\": \"\",\n \"custom_date_5\": \"\",\n \"custom_date_6\": \"\",\n \"custom_date_7\": \"\",\n \"custom_date_8\": \"\",\n \"custom_date_9\": \"\",\n \"custom_date_10\": \"\",\n \"is_deleted\": \"\",\n \"deleted_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n]", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"string\",\n \"code\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "216e971a-24f7-4a24-ae14-c30763cf66ad", "name": "Delete receipts", "request": { "name": "Delete receipts", "description": { "content": "\nSoft-delete purchase order receipts based on filter criteria. Sets\n`is_deleted = true` and `deleted_at = NOW()`.\n\n**No `action` field**: previous versions accepted `action: 'delete' | 'deactivate'`.\nThat parameter is no longer supported — the only supported behavior is\nsoft-delete. Sending `action` in the request body returns 400.\n\n**Filter parameters** array — each entry runs as one independent UPDATE; fields\nwithin an entry combine with AND.\n ", "type": "text/plain" }, "url": { "path": [ "v1", "receipt" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"parameters\": [\n {\n \"po_number\": \"\",\n \"po_line_number\": \"\",\n \"receipt_line_number\": \"\",\n \"created_before_date\": \"\",\n \"created_after_date\": \"\",\n \"updated_before_date\": \"\",\n \"updated_after_date\": \"\"\n },\n {\n \"po_number\": \"\",\n \"po_line_number\": \"\",\n \"receipt_line_number\": \"\",\n \"created_before_date\": \"\",\n \"created_after_date\": \"\",\n \"updated_before_date\": \"\",\n \"updated_after_date\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "831f7335-0459-4745-b761-9d83f67a9bfb", "name": "Receipts soft-deleted successfully", "originalRequest": { "url": { "path": [ "v1", "receipt" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"parameters\": [\n {\n \"po_number\": \"\",\n \"po_line_number\": \"\",\n \"receipt_line_number\": \"\",\n \"created_before_date\": \"\",\n \"created_after_date\": \"\",\n \"updated_before_date\": \"\",\n \"updated_after_date\": \"\"\n },\n {\n \"po_number\": \"\",\n \"po_line_number\": \"\",\n \"receipt_line_number\": \"\",\n \"created_before_date\": \"\",\n \"created_after_date\": \"\",\n \"updated_before_date\": \"\",\n \"updated_after_date\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Receipts successfully soft-deleted.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7f23aa8e-7a6d-40c8-9fe0-999694143abf", "name": "Bad request - legacy action field present, or missing parameters", "originalRequest": { "url": { "path": [ "v1", "receipt" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"parameters\": [\n {\n \"po_number\": \"\",\n \"po_line_number\": \"\",\n \"receipt_line_number\": \"\",\n \"created_before_date\": \"\",\n \"created_after_date\": \"\",\n \"updated_before_date\": \"\",\n \"updated_after_date\": \"\"\n },\n {\n \"po_number\": \"\",\n \"po_line_number\": \"\",\n \"receipt_line_number\": \"\",\n \"created_before_date\": \"\",\n \"created_after_date\": \"\",\n \"updated_before_date\": \"\",\n \"updated_after_date\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"The \\\"action\\\" field is no longer accepted on /receipt. DELETE now always soft-deletes (is_deleted = true). Remove \\\"action\\\" from your request body.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2501f5c8-5d18-48b9-8d70-1cf595a6b2a2", "name": "Unauthorized - invalid or missing API key", "originalRequest": { "url": { "path": [ "v1", "receipt" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"parameters\": [\n {\n \"po_number\": \"\",\n \"po_line_number\": \"\",\n \"receipt_line_number\": \"\",\n \"created_before_date\": \"\",\n \"created_after_date\": \"\",\n \"updated_before_date\": \"\",\n \"updated_after_date\": \"\"\n },\n {\n \"po_number\": \"\",\n \"po_line_number\": \"\",\n \"receipt_line_number\": \"\",\n \"created_before_date\": \"\",\n \"created_after_date\": \"\",\n \"updated_before_date\": \"\",\n \"updated_after_date\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"string\",\n \"code\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8b77d53e-6168-4a64-966a-f188d6d8cef6", "name": "Forbidden - insufficient permissions", "originalRequest": { "url": { "path": [ "v1", "receipt" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"parameters\": [\n {\n \"po_number\": \"\",\n \"po_line_number\": \"\",\n \"receipt_line_number\": \"\",\n \"created_before_date\": \"\",\n \"created_after_date\": \"\",\n \"updated_before_date\": \"\",\n \"updated_after_date\": \"\"\n },\n {\n \"po_number\": \"\",\n \"po_line_number\": \"\",\n \"receipt_line_number\": \"\",\n \"created_before_date\": \"\",\n \"created_after_date\": \"\",\n \"updated_before_date\": \"\",\n \"updated_after_date\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"Forbidden\",\n \"message\": \"API user does not have required permissions: POST_RECEIPT, POST_DATA\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6e550f57-9da3-47d3-8c5b-fceda0591681", "name": "Internal server error", "originalRequest": { "url": { "path": [ "v1", "receipt" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"parameters\": [\n {\n \"po_number\": \"\",\n \"po_line_number\": \"\",\n \"receipt_line_number\": \"\",\n \"created_before_date\": \"\",\n \"created_after_date\": \"\",\n \"updated_before_date\": \"\",\n \"updated_after_date\": \"\"\n },\n {\n \"po_number\": \"\",\n \"po_line_number\": \"\",\n \"receipt_line_number\": \"\",\n \"created_before_date\": \"\",\n \"created_after_date\": \"\",\n \"updated_before_date\": \"\",\n \"updated_after_date\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"string\",\n \"code\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "a3108bd2-05b7-4270-98a6-3340818f93ad", "name": "Receiving Inboxes", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "a49c264c-2c6b-4576-91cf-0a8ab0f14ee3", "name": "List receiving inboxes", "request": { "name": "List receiving inboxes", "description": { "content": "\nRetrieve all receiving email inboxes configured for the authenticated API user's customer.\n\n**Environment-Aware Email Addresses:**\nThe `current_receiving_inbox` field returns the appropriate email address based on the `NODE_ENV` environment variable:\n- **development**: Returns `dev_email_address`\n- **test**: Returns `test_email_address`\n- **production**: Returns `email_address`\n\n**Active Status Filtering:**\nBy default, only active inboxes are returned. Use the `includeInactive=true` query parameter to include inactive inboxes.\n\n**Response Fields:**\n- `current_receiving_inbox`: Email address for current environment\n- `dev_receiving_inbox`: Development environment email\n- `test_receiving_inbox`: Test environment email\n- `prod_receiving_inbox`: Production environment email\n- `default_receiving_inbox`: Boolean indicating if this is the default inbox\n- `allow_manual_file_upload`: Boolean for manual UI upload permission\n- `allow_api_file_upload`: Boolean for API file upload permission\n- `allow_api_invoice_upload`: Boolean for API invoice upload permission\n- `active`: Boolean indicating if inbox is active\n ", "type": "text/plain" }, "url": { "path": [ "v1", "receiving-inbox" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "key": "includeInactive", "value": "false", "description": "Include inactive receiving inboxes. Default: false (only active inboxes returned)" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "bbe4378d-edda-4fa1-9593-c88b651ce4fa", "name": "Successfully retrieved receiving inboxes", "originalRequest": { "url": { "path": [ "v1", "receiving-inbox" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "includeInactive", "value": "true" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"data\": {\n \"environment\": \"development\",\n \"receivingInboxes\": [\n {\n \"id\": 1,\n \"customer_id\": 100,\n \"default_receiving_inbox\": true,\n \"allow_manual_file_upload\": true,\n \"allow_api_file_upload\": true,\n \"allow_api_invoice_upload\": true,\n \"active\": true,\n \"current_receiving_inbox\": \"dev.invoices@apreceiving.com\",\n \"dev_receiving_inbox\": \"dev.invoices@apreceiving.com\",\n \"test_receiving_inbox\": \"test.invoices@apreceiving.com\",\n \"prod_receiving_inbox\": \"invoices@apreceiving.com\"\n },\n {\n \"id\": 2,\n \"customer_id\": 100,\n \"default_receiving_inbox\": false,\n \"allow_manual_file_upload\": false,\n \"allow_api_file_upload\": true,\n \"allow_api_invoice_upload\": false,\n \"active\": true,\n \"current_receiving_inbox\": \"dev.api@apreceiving.com\",\n \"dev_receiving_inbox\": \"dev.api@apreceiving.com\",\n \"test_receiving_inbox\": \"test.api@apreceiving.com\",\n \"prod_receiving_inbox\": \"api@apreceiving.com\"\n }\n ],\n \"count\": 2\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1f52d430-0857-429c-9faf-843116f78b6e", "name": "Unauthorized - invalid or missing API key", "originalRequest": { "url": { "path": [ "v1", "receiving-inbox" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "includeInactive", "value": "true" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"Unauthorized\",\n \"message\": \"API key is required\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e11347e3-6bc5-49f4-abe2-4bf19f1d5a78", "name": "Forbidden - insufficient permissions", "originalRequest": { "url": { "path": [ "v1", "receiving-inbox" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "includeInactive", "value": "true" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"Forbidden\",\n \"message\": \"API user does not have required permissions: READ_DATA\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e6089842-ed40-4c88-a79b-94638cb1b1bf", "name": "Internal server error", "originalRequest": { "url": { "path": [ "v1", "receiving-inbox" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "includeInactive", "value": "true" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"Internal server error\",\n \"message\": \"Failed to fetch receiving inboxes\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "04fdffc9-5711-45d9-a0f2-82667f688c62", "name": "Source Documents", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "16af62ff-be98-46b3-95a4-609950aeb9c4", "name": "Create source document", "request": { "name": "Create source document", "description": { "content": "\nUpload one or more files to create a source document that will be automatically submitted for invoice extraction processing.\nSupports PDF files, ZIP archives, and multiple file uploads.\n\n**Processing Flow:**\n1. Files are uploaded to S3 customer bucket\n2. ZIP files are automatically extracted\n3. Source document is created with status \"processing\"\n4. PDF files are queued for AWS Textract processing\n5. Processing occurs asynchronously in background\n\n**File Support:**\n- **PDF files (.pdf)**: Automatically processed for invoice extraction\n- **ZIP archives (.zip)**: Extracted, PDF files inside are processed\n- **Other files**: Stored as attachments, not processed\n- **Multiple files**: Upload up to 20 files in a single request\n\n**Limits:**\n- Max file size: 50 MB per file\n- Max files per request: 20\n ", "type": "text/plain" }, "url": { "path": [ "v1", "source-document" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "formdata", "formdata": [ { "key": "files", "type": "file", "description": "(Required) One or more files to upload (PDF, ZIP, images, documents, etc.). Maximum 20 files per request.", "src": [] }, { "key": "company_code", "value": "", "type": "text", "description": "Optional company code for filtering or routing purposes" }, { "key": "supplier_code", "value": "", "type": "text", "description": "Optional supplier code for filtering or routing purposes" }, { "key": "receiving_inbox", "value": "", "type": "text", "description": "Optional receiving inbox email address. If not provided, defaults to default API inbox for the customer." } ] } }, "response": [ { "id": "ee1570f5-994f-42e4-8422-f313b5e20647", "name": "Source document created and processing started successfully", "originalRequest": { "url": { "path": [ "v1", "source-document" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) One or more files to upload (PDF, ZIP, images, documents, etc.). Maximum 20 files per request.", "type": "text/plain" }, "key": "files", "value": "[\"invoice.pdf\"]", "type": "text" }, { "description": { "content": "Optional company code for filtering or routing purposes", "type": "text/plain" }, "key": "company_code", "value": "COMP001", "type": "text" }, { "description": { "content": "Optional supplier code for filtering or routing purposes", "type": "text/plain" }, "key": "supplier_code", "value": "SUPP123", "type": "text" }, { "description": { "content": "Optional receiving inbox email address. If not provided, defaults to default API inbox for the customer.", "type": "text/plain" }, "key": "receiving_inbox", "value": "invoices@apreceiving.com", "type": "text" } ] } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"data\": {\n \"sourceDocumentId\": 12345,\n \"filesUploaded\": 3,\n \"pdfFilesQueued\": 2,\n \"status\": \"processing\",\n \"message\": \"Source document created and processing started\",\n \"details\": {\n \"uploadSessionId\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"uploadReference\": \"API Upload - Sep 30, 2025 at 02:30 PM by api_user\",\n \"companyCode\": \"COMP001\",\n \"supplierCode\": \"SUPP123\",\n \"totalPdfs\": 2,\n \"filesProcessed\": 2\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "011b1d23-517b-4f34-84f8-be14443cf066", "name": "Bad request - validation error", "originalRequest": { "url": { "path": [ "v1", "source-document" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) One or more files to upload (PDF, ZIP, images, documents, etc.). Maximum 20 files per request.", "type": "text/plain" }, "key": "files", "value": "[\"invoice.pdf\"]", "type": "text" }, { "description": { "content": "Optional company code for filtering or routing purposes", "type": "text/plain" }, "key": "company_code", "value": "COMP001", "type": "text" }, { "description": { "content": "Optional supplier code for filtering or routing purposes", "type": "text/plain" }, "key": "supplier_code", "value": "SUPP123", "type": "text" }, { "description": { "content": "Optional receiving inbox email address. If not provided, defaults to default API inbox for the customer.", "type": "text/plain" }, "key": "receiving_inbox", "value": "invoices@apreceiving.com", "type": "text" } ] } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"No files provided\",\n \"message\": \"At least one file must be uploaded\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bb18c620-0cb7-475b-953d-912b6bec3a45", "name": "Unauthorized - invalid or missing API key", "originalRequest": { "url": { "path": [ "v1", "source-document" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) One or more files to upload (PDF, ZIP, images, documents, etc.). Maximum 20 files per request.", "type": "text/plain" }, "key": "files", "value": "[\"invoice.pdf\"]", "type": "text" }, { "description": { "content": "Optional company code for filtering or routing purposes", "type": "text/plain" }, "key": "company_code", "value": "COMP001", "type": "text" }, { "description": { "content": "Optional supplier code for filtering or routing purposes", "type": "text/plain" }, "key": "supplier_code", "value": "SUPP123", "type": "text" }, { "description": { "content": "Optional receiving inbox email address. If not provided, defaults to default API inbox for the customer.", "type": "text/plain" }, "key": "receiving_inbox", "value": "invoices@apreceiving.com", "type": "text" } ] } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"Unauthorized\",\n \"message\": \"API key is required\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "69cefbcb-5fd4-48b3-8d1e-accd1b9e5e0a", "name": "Forbidden - insufficient permissions", "originalRequest": { "url": { "path": [ "v1", "source-document" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) One or more files to upload (PDF, ZIP, images, documents, etc.). Maximum 20 files per request.", "type": "text/plain" }, "key": "files", "value": "[\"invoice.pdf\"]", "type": "text" }, { "description": { "content": "Optional company code for filtering or routing purposes", "type": "text/plain" }, "key": "company_code", "value": "COMP001", "type": "text" }, { "description": { "content": "Optional supplier code for filtering or routing purposes", "type": "text/plain" }, "key": "supplier_code", "value": "SUPP123", "type": "text" }, { "description": { "content": "Optional receiving inbox email address. If not provided, defaults to default API inbox for the customer.", "type": "text/plain" }, "key": "receiving_inbox", "value": "invoices@apreceiving.com", "type": "text" } ] } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"Forbidden\",\n \"message\": \"API user does not have required permissions: POST_DATA, POST_SOURCEDOC\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e4538a54-63b6-4250-9779-31ca2c3898c1", "name": "Internal server error - processing failure", "originalRequest": { "url": { "path": [ "v1", "source-document" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) One or more files to upload (PDF, ZIP, images, documents, etc.). Maximum 20 files per request.", "type": "text/plain" }, "key": "files", "value": "[\"invoice.pdf\"]", "type": "text" }, { "description": { "content": "Optional company code for filtering or routing purposes", "type": "text/plain" }, "key": "company_code", "value": "COMP001", "type": "text" }, { "description": { "content": "Optional supplier code for filtering or routing purposes", "type": "text/plain" }, "key": "supplier_code", "value": "SUPP123", "type": "text" }, { "description": { "content": "Optional receiving inbox email address. If not provided, defaults to default API inbox for the customer.", "type": "text/plain" }, "key": "receiving_inbox", "value": "invoices@apreceiving.com", "type": "text" } ] } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"Internal server error\",\n \"message\": \"Failed to create and process source document\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "71565c24-235f-483f-aec2-620c6a72e6bb", "name": "Supplier", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "c32fdfa0-db7b-4580-9721-c0be23a7a70f", "name": "List suppliers", "request": { "name": "List suppliers", "description": { "content": "Returns a paginated list of suppliers including locations, addresses, and bank accounts. Only non-deleted records are returned.", "type": "text/plain" }, "url": { "path": [ "v1", "supplier" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "key": "page", "value": "1", "description": "Page number for pagination" }, { "disabled": true, "key": "limit", "value": "1000", "description": "Number of records per page (max 1000)" }, { "disabled": true, "key": "supplier_number", "value": "", "description": "Filter by supplier number (substring, case-insensitive)" }, { "disabled": true, "key": "supplier_name", "value": "", "description": "Filter by supplier name (substring, case-insensitive)" }, { "disabled": true, "key": "organization_code", "value": "", "description": "Filter by organization code (substring, case-insensitive)" }, { "disabled": true, "key": "supplier_type", "value": "", "description": "Filter by supplier type" }, { "disabled": true, "key": "is_active", "value": "", "description": "Filter by active status" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "a1bde0fc-e823-4130-8177-75aae08c2925", "name": "List of suppliers with nested locations, addresses, and bank accounts", "originalRequest": { "url": { "path": [ "v1", "supplier" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "limit", "value": "1000" }, { "key": "supplier_number", "value": "" }, { "key": "supplier_name", "value": "" }, { "key": "organization_code", "value": "" }, { "key": "supplier_type", "value": "" }, { "key": "is_active", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"count\": 2363,\n \"page\": 9998,\n \"totalPages\": 4741,\n \"suppliers\": [\n {\n \"supplier_number\": \"string\",\n \"supplier_name\": \"string\",\n \"supplier_id\": \"f2574d40-ec9a-6586-c809-7634ac798f25\",\n \"alternative_supplier_name\": \"string\",\n \"supplier_type\": \"string\",\n \"organization_code\": \"string\",\n \"is_active\": true,\n \"is_deleted\": false,\n \"deleted_at\": \"2021-05-19T06:03:35.698Z\",\n \"custom_field_1\": \"string\",\n \"custom_field_2\": \"string\",\n \"custom_field_3\": \"string\",\n \"custom_field_4\": \"string\",\n \"custom_field_5\": \"string\",\n \"created_at\": \"2012-05-16T23:46:10.384Z\",\n \"updated_at\": \"1950-01-17T10:20:37.287Z\",\n \"supplier_location\": [\n {\n \"supplier_location_id\": \"ddb53c28-d4b3-2a9a-ad2d-8910847f19fd\",\n \"supplier_id\": \"9e8d1992-3141-8f66-3178-967a95ba755d\",\n \"location_code\": \"string\",\n \"location_name\": \"string\",\n \"organization_code\": \"string\",\n \"site_purpose\": 9379,\n \"default_currency_code\": \"string\",\n \"default_payment_term_code\": \"string\",\n \"default_payment_method\": \"string\",\n \"taxpayer_id\": \"string\",\n \"duns_number\": \"string\",\n \"is_active\": true,\n \"custom_field_1\": \"string\",\n \"custom_field_2\": \"string\",\n \"custom_field_3\": \"string\",\n \"custom_field_4\": \"string\",\n \"custom_field_5\": \"string\",\n \"created_at\": \"1984-11-13T14:46:23.933Z\",\n \"updated_at\": \"2000-02-16T01:59:17.574Z\",\n \"supplier_address\": [\n {\n \"supplier_location_id\": \"85e0991d-08ef-b8e3-0f04-fd6c13245f3a\",\n \"street\": \"string\",\n \"city\": \"string\",\n \"state\": \"string\",\n \"postal_code\": \"string\",\n \"country_code\": \"string\",\n \"custom_field_1\": \"string\",\n \"custom_field_2\": \"string\",\n \"custom_field_3\": \"string\"\n },\n {\n \"supplier_location_id\": \"926975d9-2b81-5607-f41d-23c8b438f195\",\n \"street\": \"string\",\n \"city\": \"string\",\n \"state\": \"string\",\n \"postal_code\": \"string\",\n \"country_code\": \"string\",\n \"custom_field_1\": \"string\",\n \"custom_field_2\": \"string\",\n \"custom_field_3\": \"string\"\n }\n ],\n \"supplier_bank_account\": [\n {\n \"supplier_location_id\": \"ae4ebdbb-f511-b4da-7515-6acb1013c20d\",\n \"bank_name\": \"string\",\n \"bank_branch\": \"string\",\n \"bank_account_number\": \"string\",\n \"bank_routing_number\": \"string\",\n \"swift_code\": \"string\",\n \"account_currency\": \"string\",\n \"is_primary\": false,\n \"custom_field_1\": \"string\",\n \"custom_field_2\": \"string\",\n \"custom_field_3\": \"string\"\n },\n {\n \"supplier_location_id\": \"acbc6f58-df81-6fa0-c3b9-cfef5c9418c8\",\n \"bank_name\": \"string\",\n \"bank_branch\": \"string\",\n \"bank_account_number\": \"string\",\n \"bank_routing_number\": \"string\",\n \"swift_code\": \"string\",\n \"account_currency\": \"string\",\n \"is_primary\": true,\n \"custom_field_1\": \"string\",\n \"custom_field_2\": \"string\",\n \"custom_field_3\": \"string\"\n }\n ]\n },\n {\n \"supplier_location_id\": \"cb51064e-d70a-68c9-f3e2-d145263e996e\",\n \"supplier_id\": \"b7a311d4-6ccf-264b-4949-065d2fae02f3\",\n \"location_code\": \"string\",\n \"location_name\": \"string\",\n \"organization_code\": \"string\",\n \"site_purpose\": 2980,\n \"default_currency_code\": \"string\",\n \"default_payment_term_code\": \"string\",\n \"default_payment_method\": \"string\",\n \"taxpayer_id\": \"string\",\n \"duns_number\": \"string\",\n \"is_active\": true,\n \"custom_field_1\": \"string\",\n \"custom_field_2\": \"string\",\n \"custom_field_3\": \"string\",\n \"custom_field_4\": \"string\",\n \"custom_field_5\": \"string\",\n \"created_at\": \"1958-08-20T15:40:54.064Z\",\n \"updated_at\": \"2022-10-11T02:37:44.661Z\",\n \"supplier_address\": [\n {\n \"supplier_location_id\": \"6c49aa3e-7a67-ce8a-cdba-c746acfa3f42\",\n \"street\": \"string\",\n \"city\": \"string\",\n \"state\": \"string\",\n \"postal_code\": \"string\",\n \"country_code\": \"string\",\n \"custom_field_1\": \"string\",\n \"custom_field_2\": \"string\",\n \"custom_field_3\": \"string\"\n },\n {\n \"supplier_location_id\": \"d8959889-9000-e030-8c31-c0307dd0cad9\",\n \"street\": \"string\",\n \"city\": \"string\",\n \"state\": \"string\",\n \"postal_code\": \"string\",\n \"country_code\": \"string\",\n \"custom_field_1\": \"string\",\n \"custom_field_2\": \"string\",\n \"custom_field_3\": \"string\"\n }\n ],\n \"supplier_bank_account\": [\n {\n \"supplier_location_id\": \"f1f4410e-c631-9a20-1467-10f904a07dc4\",\n \"bank_name\": \"string\",\n \"bank_branch\": \"string\",\n \"bank_account_number\": \"string\",\n \"bank_routing_number\": \"string\",\n \"swift_code\": \"string\",\n \"account_currency\": \"string\",\n \"is_primary\": true,\n \"custom_field_1\": \"string\",\n \"custom_field_2\": \"string\",\n \"custom_field_3\": \"string\"\n },\n {\n \"supplier_location_id\": \"355ec960-56f5-db29-d2eb-29bc37fa9885\",\n \"bank_name\": \"string\",\n \"bank_branch\": \"string\",\n \"bank_account_number\": \"string\",\n \"bank_routing_number\": \"string\",\n \"swift_code\": \"string\",\n \"account_currency\": \"string\",\n \"is_primary\": false,\n \"custom_field_1\": \"string\",\n \"custom_field_2\": \"string\",\n \"custom_field_3\": \"string\"\n }\n ]\n }\n ]\n },\n {\n \"supplier_number\": \"string\",\n \"supplier_name\": \"string\",\n \"supplier_id\": \"e87297a4-e9d4-b539-80bd-e688064f534b\",\n \"alternative_supplier_name\": \"string\",\n \"supplier_type\": \"string\",\n \"organization_code\": \"string\",\n \"is_active\": true,\n \"is_deleted\": true,\n \"deleted_at\": \"1965-04-05T08:31:29.536Z\",\n \"custom_field_1\": \"string\",\n \"custom_field_2\": \"string\",\n \"custom_field_3\": \"string\",\n \"custom_field_4\": \"string\",\n \"custom_field_5\": \"string\",\n \"created_at\": \"1984-06-29T14:27:33.473Z\",\n \"updated_at\": \"2014-07-27T07:39:15.478Z\",\n \"supplier_location\": [\n {\n \"supplier_location_id\": \"fb7faa89-3141-501c-e2dc-d4c4978da3c4\",\n \"supplier_id\": \"f334a92e-9617-05b8-a933-93e4d5aef24a\",\n \"location_code\": \"string\",\n \"location_name\": \"string\",\n \"organization_code\": \"string\",\n \"site_purpose\": 4821,\n \"default_currency_code\": \"string\",\n \"default_payment_term_code\": \"string\",\n \"default_payment_method\": \"string\",\n \"taxpayer_id\": \"string\",\n \"duns_number\": \"string\",\n \"is_active\": true,\n \"custom_field_1\": \"string\",\n \"custom_field_2\": \"string\",\n \"custom_field_3\": \"string\",\n \"custom_field_4\": \"string\",\n \"custom_field_5\": \"string\",\n \"created_at\": \"2013-10-25T23:00:23.259Z\",\n \"updated_at\": \"2015-09-15T19:11:35.429Z\",\n \"supplier_address\": [\n {\n \"supplier_location_id\": \"eee2a7f6-6e7e-b1c9-7513-1061e9fb8fec\",\n \"street\": \"string\",\n \"city\": \"string\",\n \"state\": \"string\",\n \"postal_code\": \"string\",\n \"country_code\": \"string\",\n \"custom_field_1\": \"string\",\n \"custom_field_2\": \"string\",\n \"custom_field_3\": \"string\"\n },\n {\n \"supplier_location_id\": \"366077a5-d3ae-209f-1144-c9f9b970d064\",\n \"street\": \"string\",\n \"city\": \"string\",\n \"state\": \"string\",\n \"postal_code\": \"string\",\n \"country_code\": \"string\",\n \"custom_field_1\": \"string\",\n \"custom_field_2\": \"string\",\n \"custom_field_3\": \"string\"\n }\n ],\n \"supplier_bank_account\": [\n {\n \"supplier_location_id\": \"29bc26d0-c6f3-c4c4-1541-77f9654e0efa\",\n \"bank_name\": \"string\",\n \"bank_branch\": \"string\",\n \"bank_account_number\": \"string\",\n \"bank_routing_number\": \"string\",\n \"swift_code\": \"string\",\n \"account_currency\": \"string\",\n \"is_primary\": false,\n \"custom_field_1\": \"string\",\n \"custom_field_2\": \"string\",\n \"custom_field_3\": \"string\"\n },\n {\n \"supplier_location_id\": \"f25104e1-9521-76d7-6464-d7b416e28200\",\n \"bank_name\": \"string\",\n \"bank_branch\": \"string\",\n \"bank_account_number\": \"string\",\n \"bank_routing_number\": \"string\",\n \"swift_code\": \"string\",\n \"account_currency\": \"string\",\n \"is_primary\": false,\n \"custom_field_1\": \"string\",\n \"custom_field_2\": \"string\",\n \"custom_field_3\": \"string\"\n }\n ]\n },\n {\n \"supplier_location_id\": \"2fe68194-17b4-2b79-934e-072ddb8e7a22\",\n \"supplier_id\": \"f43a2044-0603-df38-3b30-2b32e2a60271\",\n \"location_code\": \"string\",\n \"location_name\": \"string\",\n \"organization_code\": \"string\",\n \"site_purpose\": 6088,\n \"default_currency_code\": \"string\",\n \"default_payment_term_code\": \"string\",\n \"default_payment_method\": \"string\",\n \"taxpayer_id\": \"string\",\n \"duns_number\": \"string\",\n \"is_active\": true,\n \"custom_field_1\": \"string\",\n \"custom_field_2\": \"string\",\n \"custom_field_3\": \"string\",\n \"custom_field_4\": \"string\",\n \"custom_field_5\": \"string\",\n \"created_at\": \"2001-06-09T04:43:32.412Z\",\n \"updated_at\": \"1972-07-23T21:21:20.291Z\",\n \"supplier_address\": [\n {\n \"supplier_location_id\": \"a53bbff1-fa00-0ef6-457a-9172189838a5\",\n \"street\": \"string\",\n \"city\": \"string\",\n \"state\": \"string\",\n \"postal_code\": \"string\",\n \"country_code\": \"string\",\n \"custom_field_1\": \"string\",\n \"custom_field_2\": \"string\",\n \"custom_field_3\": \"string\"\n },\n {\n \"supplier_location_id\": \"d86f860c-f368-0c85-f1c4-51f9940525c9\",\n \"street\": \"string\",\n \"city\": \"string\",\n \"state\": \"string\",\n \"postal_code\": \"string\",\n \"country_code\": \"string\",\n \"custom_field_1\": \"string\",\n \"custom_field_2\": \"string\",\n \"custom_field_3\": \"string\"\n }\n ],\n \"supplier_bank_account\": [\n {\n \"supplier_location_id\": \"9109e698-406d-a17e-90a3-dcc3697784d4\",\n \"bank_name\": \"string\",\n \"bank_branch\": \"string\",\n \"bank_account_number\": \"string\",\n \"bank_routing_number\": \"string\",\n \"swift_code\": \"string\",\n \"account_currency\": \"string\",\n \"is_primary\": true,\n \"custom_field_1\": \"string\",\n \"custom_field_2\": \"string\",\n \"custom_field_3\": \"string\"\n },\n {\n \"supplier_location_id\": \"3c0b9756-0625-b218-9411-335e84fe96dd\",\n \"bank_name\": \"string\",\n \"bank_branch\": \"string\",\n \"bank_account_number\": \"string\",\n \"bank_routing_number\": \"string\",\n \"swift_code\": \"string\",\n \"account_currency\": \"string\",\n \"is_primary\": true,\n \"custom_field_1\": \"string\",\n \"custom_field_2\": \"string\",\n \"custom_field_3\": \"string\"\n }\n ]\n }\n ]\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b1fab3d3-453f-49df-a82c-8fd773d41e80", "name": "Unauthorized - invalid or missing API key", "originalRequest": { "url": { "path": [ "v1", "supplier" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "limit", "value": "1000" }, { "key": "supplier_number", "value": "" }, { "key": "supplier_name", "value": "" }, { "key": "organization_code", "value": "" }, { "key": "supplier_type", "value": "" }, { "key": "is_active", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"Unauthorized\",\n \"message\": \"API key is required\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "36e90e63-4fd7-4ce7-9ca0-99cafeefe4be", "name": "Forbidden - insufficient permissions", "originalRequest": { "url": { "path": [ "v1", "supplier" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "limit", "value": "1000" }, { "key": "supplier_number", "value": "" }, { "key": "supplier_name", "value": "" }, { "key": "organization_code", "value": "" }, { "key": "supplier_type", "value": "" }, { "key": "is_active", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"Forbidden\",\n \"message\": \"API user does not have required permissions: READ_SUPPLIER, READ_DATA\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cbd20974-2daa-4233-a4a2-ce61f87c9ced", "name": "Internal server error", "originalRequest": { "url": { "path": [ "v1", "supplier" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "limit", "value": "1000" }, { "key": "supplier_number", "value": "" }, { "key": "supplier_name", "value": "" }, { "key": "organization_code", "value": "" }, { "key": "supplier_type", "value": "" }, { "key": "is_active", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"Internal server error\",\n \"message\": \"Database query failed\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "77eed37c-b605-4c76-81bc-57123055f5c8", "name": "Upsert suppliers", "request": { "name": "Upsert suppliers", "description": { "content": "\nImport or update suppliers with locations, addresses, and bank accounts. Supports both incremental updates and full data replacement.\n\n**Upsert Key**: (supplier_number, organization_code) (`ON CONFLICT` target)\n\n**full_load Behavior**:\n- **false** (default): Incremental upsert — updates existing records (matched by supplier_number + organization_code), inserts new ones\n- **true**: Full replacement — deletes ALL existing suppliers for the customer, then inserts new data\n\n**Additional Options**:\n- **SupplierAddressInsertOnly**: If true, only inserts new addresses without updating existing ones\n- **SupplierBankInsertOnly**: If true, only inserts new bank accounts without updating existing ones\n\n**Required Fields**: supplier_number, supplier_name. `organization_code` is part of the upsert key but not validated as required at the API level — if omitted it falls back to a default and may collide on the natural key.\n ", "type": "text/plain" }, "url": { "path": [ "v1", "supplier" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "key": "full_load", "value": "false", "description": "If true, clears all existing suppliers before inserting new data" }, { "disabled": true, "key": "SupplierAddressInsertOnly", "value": "false", "description": "If true, only inserts new addresses without updating existing ones" }, { "disabled": true, "key": "SupplierBankInsertOnly", "value": "false", "description": "If true, only inserts new bank accounts without updating existing ones" } ], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "[\n {\n \"supplier_number\": \"\",\n \"supplier_name\": \"\",\n \"supplier_id\": \"\",\n \"alternative_supplier_name\": \"\",\n \"supplier_type\": \"\",\n \"organization_code\": \"\",\n \"is_active\": \"\",\n \"is_deleted\": \"\",\n \"deleted_at\": \"\",\n \"custom_field_1\": \"\",\n \"custom_field_2\": \"\",\n \"custom_field_3\": \"\",\n \"custom_field_4\": \"\",\n \"custom_field_5\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"supplier_location\": [\n {\n \"supplier_location_id\": \"\",\n \"supplier_id\": \"\",\n \"location_code\": \"\",\n \"location_name\": \"\",\n \"organization_code\": \"\",\n \"site_purpose\": \"\",\n \"default_currency_code\": \"\",\n \"default_payment_term_code\": \"\",\n \"default_payment_method\": \"\",\n \"taxpayer_id\": \"\",\n \"duns_number\": \"\",\n \"is_active\": \"\",\n \"custom_field_1\": \"\",\n \"custom_field_2\": \"\",\n \"custom_field_3\": \"\",\n \"custom_field_4\": \"\",\n \"custom_field_5\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"supplier_address\": [\n {\n \"supplier_location_id\": \"\",\n \"street\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"\",\n \"country_code\": \"\",\n \"custom_field_1\": \"\",\n \"custom_field_2\": \"\",\n \"custom_field_3\": \"\"\n },\n {\n \"supplier_location_id\": \"\",\n \"street\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"\",\n \"country_code\": \"\",\n \"custom_field_1\": \"\",\n \"custom_field_2\": \"\",\n \"custom_field_3\": \"\"\n }\n ],\n \"supplier_bank_account\": [\n {\n \"supplier_location_id\": \"\",\n \"bank_name\": \"\",\n \"bank_branch\": \"\",\n \"bank_account_number\": \"\",\n \"bank_routing_number\": \"\",\n \"swift_code\": \"\",\n \"account_currency\": \"\",\n \"is_primary\": \"\",\n \"custom_field_1\": \"\",\n \"custom_field_2\": \"\",\n \"custom_field_3\": \"\"\n },\n {\n \"supplier_location_id\": \"\",\n \"bank_name\": \"\",\n \"bank_branch\": \"\",\n \"bank_account_number\": \"\",\n \"bank_routing_number\": \"\",\n \"swift_code\": \"\",\n \"account_currency\": \"\",\n \"is_primary\": \"\",\n \"custom_field_1\": \"\",\n \"custom_field_2\": \"\",\n \"custom_field_3\": \"\"\n }\n ]\n },\n {\n \"supplier_location_id\": \"\",\n \"supplier_id\": \"\",\n \"location_code\": \"\",\n \"location_name\": \"\",\n \"organization_code\": \"\",\n \"site_purpose\": \"\",\n \"default_currency_code\": \"\",\n \"default_payment_term_code\": \"\",\n \"default_payment_method\": \"\",\n \"taxpayer_id\": \"\",\n \"duns_number\": \"\",\n \"is_active\": \"\",\n \"custom_field_1\": \"\",\n \"custom_field_2\": \"\",\n \"custom_field_3\": \"\",\n \"custom_field_4\": \"\",\n \"custom_field_5\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"supplier_address\": [\n {\n \"supplier_location_id\": \"\",\n \"street\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"\",\n \"country_code\": \"\",\n \"custom_field_1\": \"\",\n \"custom_field_2\": \"\",\n \"custom_field_3\": \"\"\n },\n {\n \"supplier_location_id\": \"\",\n \"street\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"\",\n \"country_code\": \"\",\n \"custom_field_1\": \"\",\n \"custom_field_2\": \"\",\n \"custom_field_3\": \"\"\n }\n ],\n \"supplier_bank_account\": [\n {\n \"supplier_location_id\": \"\",\n \"bank_name\": \"\",\n \"bank_branch\": \"\",\n \"bank_account_number\": \"\",\n \"bank_routing_number\": \"\",\n \"swift_code\": \"\",\n \"account_currency\": \"\",\n \"is_primary\": \"\",\n \"custom_field_1\": \"\",\n \"custom_field_2\": \"\",\n \"custom_field_3\": \"\"\n },\n {\n \"supplier_location_id\": \"\",\n \"bank_name\": \"\",\n \"bank_branch\": \"\",\n \"bank_account_number\": \"\",\n \"bank_routing_number\": \"\",\n \"swift_code\": \"\",\n \"account_currency\": \"\",\n \"is_primary\": \"\",\n \"custom_field_1\": \"\",\n \"custom_field_2\": \"\",\n \"custom_field_3\": \"\"\n }\n ]\n }\n ]\n },\n {\n \"supplier_number\": \"\",\n \"supplier_name\": \"\",\n \"supplier_id\": \"\",\n \"alternative_supplier_name\": \"\",\n \"supplier_type\": \"\",\n \"organization_code\": \"\",\n \"is_active\": \"\",\n \"is_deleted\": \"\",\n \"deleted_at\": \"\",\n \"custom_field_1\": \"\",\n \"custom_field_2\": \"\",\n \"custom_field_3\": \"\",\n \"custom_field_4\": \"\",\n \"custom_field_5\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"supplier_location\": [\n {\n \"supplier_location_id\": \"\",\n \"supplier_id\": \"\",\n \"location_code\": \"\",\n \"location_name\": \"\",\n \"organization_code\": \"\",\n \"site_purpose\": \"\",\n \"default_currency_code\": \"\",\n \"default_payment_term_code\": \"\",\n \"default_payment_method\": \"\",\n \"taxpayer_id\": \"\",\n \"duns_number\": \"\",\n \"is_active\": \"\",\n \"custom_field_1\": \"\",\n \"custom_field_2\": \"\",\n \"custom_field_3\": \"\",\n \"custom_field_4\": \"\",\n \"custom_field_5\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"supplier_address\": [\n {\n \"supplier_location_id\": \"\",\n \"street\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"\",\n \"country_code\": \"\",\n \"custom_field_1\": \"\",\n \"custom_field_2\": \"\",\n \"custom_field_3\": \"\"\n },\n {\n \"supplier_location_id\": \"\",\n \"street\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"\",\n \"country_code\": \"\",\n \"custom_field_1\": \"\",\n \"custom_field_2\": \"\",\n \"custom_field_3\": \"\"\n }\n ],\n \"supplier_bank_account\": [\n {\n \"supplier_location_id\": \"\",\n \"bank_name\": \"\",\n \"bank_branch\": \"\",\n \"bank_account_number\": \"\",\n \"bank_routing_number\": \"\",\n \"swift_code\": \"\",\n \"account_currency\": \"\",\n \"is_primary\": \"\",\n \"custom_field_1\": \"\",\n \"custom_field_2\": \"\",\n \"custom_field_3\": \"\"\n },\n {\n \"supplier_location_id\": \"\",\n \"bank_name\": \"\",\n \"bank_branch\": \"\",\n \"bank_account_number\": \"\",\n \"bank_routing_number\": \"\",\n \"swift_code\": \"\",\n \"account_currency\": \"\",\n \"is_primary\": \"\",\n \"custom_field_1\": \"\",\n \"custom_field_2\": \"\",\n \"custom_field_3\": \"\"\n }\n ]\n },\n {\n \"supplier_location_id\": \"\",\n \"supplier_id\": \"\",\n \"location_code\": \"\",\n \"location_name\": \"\",\n \"organization_code\": \"\",\n \"site_purpose\": \"\",\n \"default_currency_code\": \"\",\n \"default_payment_term_code\": \"\",\n \"default_payment_method\": \"\",\n \"taxpayer_id\": \"\",\n \"duns_number\": \"\",\n \"is_active\": \"\",\n \"custom_field_1\": \"\",\n \"custom_field_2\": \"\",\n \"custom_field_3\": \"\",\n \"custom_field_4\": \"\",\n \"custom_field_5\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"supplier_address\": [\n {\n \"supplier_location_id\": \"\",\n \"street\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"\",\n \"country_code\": \"\",\n \"custom_field_1\": \"\",\n \"custom_field_2\": \"\",\n \"custom_field_3\": \"\"\n },\n {\n \"supplier_location_id\": \"\",\n \"street\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"\",\n \"country_code\": \"\",\n \"custom_field_1\": \"\",\n \"custom_field_2\": \"\",\n \"custom_field_3\": \"\"\n }\n ],\n \"supplier_bank_account\": [\n {\n \"supplier_location_id\": \"\",\n \"bank_name\": \"\",\n \"bank_branch\": \"\",\n \"bank_account_number\": \"\",\n \"bank_routing_number\": \"\",\n \"swift_code\": \"\",\n \"account_currency\": \"\",\n \"is_primary\": \"\",\n \"custom_field_1\": \"\",\n \"custom_field_2\": \"\",\n \"custom_field_3\": \"\"\n },\n {\n \"supplier_location_id\": \"\",\n \"bank_name\": \"\",\n \"bank_branch\": \"\",\n \"bank_account_number\": \"\",\n \"bank_routing_number\": \"\",\n \"swift_code\": \"\",\n \"account_currency\": \"\",\n \"is_primary\": \"\",\n \"custom_field_1\": \"\",\n \"custom_field_2\": \"\",\n \"custom_field_3\": \"\"\n }\n ]\n }\n ]\n }\n]", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "c6f44dc1-abcc-4768-a772-6e160f6be26c", "name": "Suppliers inserted successfully", "originalRequest": { "url": { "path": [ "v1", "supplier" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "full_load", "value": "false" }, { "key": "SupplierAddressInsertOnly", "value": "false" }, { "key": "SupplierBankInsertOnly", "value": "false" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "[\n {\n \"supplier_number\": \"\",\n \"supplier_name\": \"\",\n \"supplier_id\": \"\",\n \"alternative_supplier_name\": \"\",\n \"supplier_type\": \"\",\n \"organization_code\": \"\",\n \"is_active\": \"\",\n \"is_deleted\": \"\",\n \"deleted_at\": \"\",\n \"custom_field_1\": \"\",\n \"custom_field_2\": \"\",\n \"custom_field_3\": \"\",\n \"custom_field_4\": \"\",\n \"custom_field_5\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"supplier_location\": [\n {\n \"supplier_location_id\": \"\",\n \"supplier_id\": \"\",\n \"location_code\": \"\",\n \"location_name\": \"\",\n \"organization_code\": \"\",\n \"site_purpose\": \"\",\n \"default_currency_code\": \"\",\n \"default_payment_term_code\": \"\",\n \"default_payment_method\": \"\",\n \"taxpayer_id\": \"\",\n \"duns_number\": \"\",\n \"is_active\": \"\",\n \"custom_field_1\": \"\",\n \"custom_field_2\": \"\",\n \"custom_field_3\": \"\",\n \"custom_field_4\": \"\",\n \"custom_field_5\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"supplier_address\": [\n {\n \"supplier_location_id\": \"\",\n \"street\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"\",\n \"country_code\": \"\",\n \"custom_field_1\": \"\",\n \"custom_field_2\": \"\",\n \"custom_field_3\": \"\"\n },\n {\n \"supplier_location_id\": \"\",\n \"street\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"\",\n \"country_code\": \"\",\n \"custom_field_1\": \"\",\n \"custom_field_2\": \"\",\n \"custom_field_3\": \"\"\n }\n ],\n \"supplier_bank_account\": [\n {\n \"supplier_location_id\": \"\",\n \"bank_name\": \"\",\n \"bank_branch\": \"\",\n \"bank_account_number\": \"\",\n \"bank_routing_number\": \"\",\n \"swift_code\": \"\",\n \"account_currency\": \"\",\n \"is_primary\": \"\",\n \"custom_field_1\": \"\",\n \"custom_field_2\": \"\",\n \"custom_field_3\": \"\"\n },\n {\n \"supplier_location_id\": \"\",\n \"bank_name\": \"\",\n \"bank_branch\": \"\",\n \"bank_account_number\": \"\",\n \"bank_routing_number\": \"\",\n \"swift_code\": \"\",\n \"account_currency\": \"\",\n \"is_primary\": \"\",\n \"custom_field_1\": \"\",\n \"custom_field_2\": \"\",\n \"custom_field_3\": \"\"\n }\n ]\n },\n {\n \"supplier_location_id\": \"\",\n \"supplier_id\": \"\",\n \"location_code\": \"\",\n \"location_name\": \"\",\n \"organization_code\": \"\",\n \"site_purpose\": \"\",\n \"default_currency_code\": \"\",\n \"default_payment_term_code\": \"\",\n \"default_payment_method\": \"\",\n \"taxpayer_id\": \"\",\n \"duns_number\": \"\",\n \"is_active\": \"\",\n \"custom_field_1\": \"\",\n \"custom_field_2\": \"\",\n \"custom_field_3\": \"\",\n \"custom_field_4\": \"\",\n \"custom_field_5\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"supplier_address\": [\n {\n \"supplier_location_id\": \"\",\n \"street\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"\",\n \"country_code\": \"\",\n \"custom_field_1\": \"\",\n \"custom_field_2\": \"\",\n \"custom_field_3\": \"\"\n },\n {\n \"supplier_location_id\": \"\",\n \"street\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"\",\n \"country_code\": \"\",\n \"custom_field_1\": \"\",\n \"custom_field_2\": \"\",\n \"custom_field_3\": \"\"\n }\n ],\n \"supplier_bank_account\": [\n {\n \"supplier_location_id\": \"\",\n \"bank_name\": \"\",\n \"bank_branch\": \"\",\n \"bank_account_number\": \"\",\n \"bank_routing_number\": \"\",\n \"swift_code\": \"\",\n \"account_currency\": \"\",\n \"is_primary\": \"\",\n \"custom_field_1\": \"\",\n \"custom_field_2\": \"\",\n \"custom_field_3\": \"\"\n },\n {\n \"supplier_location_id\": \"\",\n \"bank_name\": \"\",\n \"bank_branch\": \"\",\n \"bank_account_number\": \"\",\n \"bank_routing_number\": \"\",\n \"swift_code\": \"\",\n \"account_currency\": \"\",\n \"is_primary\": \"\",\n \"custom_field_1\": \"\",\n \"custom_field_2\": \"\",\n \"custom_field_3\": \"\"\n }\n ]\n }\n ]\n },\n {\n \"supplier_number\": \"\",\n \"supplier_name\": \"\",\n \"supplier_id\": \"\",\n \"alternative_supplier_name\": \"\",\n \"supplier_type\": \"\",\n \"organization_code\": \"\",\n \"is_active\": \"\",\n \"is_deleted\": \"\",\n \"deleted_at\": \"\",\n \"custom_field_1\": \"\",\n \"custom_field_2\": \"\",\n \"custom_field_3\": \"\",\n \"custom_field_4\": \"\",\n \"custom_field_5\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"supplier_location\": [\n {\n \"supplier_location_id\": \"\",\n \"supplier_id\": \"\",\n \"location_code\": \"\",\n \"location_name\": \"\",\n \"organization_code\": \"\",\n \"site_purpose\": \"\",\n \"default_currency_code\": \"\",\n \"default_payment_term_code\": \"\",\n \"default_payment_method\": \"\",\n \"taxpayer_id\": \"\",\n \"duns_number\": \"\",\n \"is_active\": \"\",\n \"custom_field_1\": \"\",\n \"custom_field_2\": \"\",\n \"custom_field_3\": \"\",\n \"custom_field_4\": \"\",\n \"custom_field_5\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"supplier_address\": [\n {\n \"supplier_location_id\": \"\",\n \"street\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"\",\n \"country_code\": \"\",\n \"custom_field_1\": \"\",\n \"custom_field_2\": \"\",\n \"custom_field_3\": \"\"\n },\n {\n \"supplier_location_id\": \"\",\n \"street\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"\",\n \"country_code\": \"\",\n \"custom_field_1\": \"\",\n \"custom_field_2\": \"\",\n \"custom_field_3\": \"\"\n }\n ],\n \"supplier_bank_account\": [\n {\n \"supplier_location_id\": \"\",\n \"bank_name\": \"\",\n \"bank_branch\": \"\",\n \"bank_account_number\": \"\",\n \"bank_routing_number\": \"\",\n \"swift_code\": \"\",\n \"account_currency\": \"\",\n \"is_primary\": \"\",\n \"custom_field_1\": \"\",\n \"custom_field_2\": \"\",\n \"custom_field_3\": \"\"\n },\n {\n \"supplier_location_id\": \"\",\n \"bank_name\": \"\",\n \"bank_branch\": \"\",\n \"bank_account_number\": \"\",\n \"bank_routing_number\": \"\",\n \"swift_code\": \"\",\n \"account_currency\": \"\",\n \"is_primary\": \"\",\n \"custom_field_1\": \"\",\n \"custom_field_2\": \"\",\n \"custom_field_3\": \"\"\n }\n ]\n },\n {\n \"supplier_location_id\": \"\",\n \"supplier_id\": \"\",\n \"location_code\": \"\",\n \"location_name\": \"\",\n \"organization_code\": \"\",\n \"site_purpose\": \"\",\n \"default_currency_code\": \"\",\n \"default_payment_term_code\": \"\",\n \"default_payment_method\": \"\",\n \"taxpayer_id\": \"\",\n \"duns_number\": \"\",\n \"is_active\": \"\",\n \"custom_field_1\": \"\",\n \"custom_field_2\": \"\",\n \"custom_field_3\": \"\",\n \"custom_field_4\": \"\",\n \"custom_field_5\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"supplier_address\": [\n {\n \"supplier_location_id\": \"\",\n \"street\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"\",\n \"country_code\": \"\",\n \"custom_field_1\": \"\",\n \"custom_field_2\": \"\",\n \"custom_field_3\": \"\"\n },\n {\n \"supplier_location_id\": \"\",\n \"street\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"\",\n \"country_code\": \"\",\n \"custom_field_1\": \"\",\n \"custom_field_2\": \"\",\n \"custom_field_3\": \"\"\n }\n ],\n \"supplier_bank_account\": [\n {\n \"supplier_location_id\": \"\",\n \"bank_name\": \"\",\n \"bank_branch\": \"\",\n \"bank_account_number\": \"\",\n \"bank_routing_number\": \"\",\n \"swift_code\": \"\",\n \"account_currency\": \"\",\n \"is_primary\": \"\",\n \"custom_field_1\": \"\",\n \"custom_field_2\": \"\",\n \"custom_field_3\": \"\"\n },\n {\n \"supplier_location_id\": \"\",\n \"bank_name\": \"\",\n \"bank_branch\": \"\",\n \"bank_account_number\": \"\",\n \"bank_routing_number\": \"\",\n \"swift_code\": \"\",\n \"account_currency\": \"\",\n \"is_primary\": \"\",\n \"custom_field_1\": \"\",\n \"custom_field_2\": \"\",\n \"custom_field_3\": \"\"\n }\n ]\n }\n ]\n }\n]", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Suppliers inserted/updated successfully\",\n \"suppliersInserted\": 20,\n \"locationsInserted\": 35\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1a034c78-43c4-4f02-9b78-d69b2d7d4619", "name": "Bad request - validation error", "originalRequest": { "url": { "path": [ "v1", "supplier" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "full_load", "value": "false" }, { "key": "SupplierAddressInsertOnly", "value": "false" }, { "key": "SupplierBankInsertOnly", "value": "false" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "[\n {\n \"supplier_number\": \"\",\n \"supplier_name\": \"\",\n \"supplier_id\": \"\",\n \"alternative_supplier_name\": \"\",\n \"supplier_type\": \"\",\n \"organization_code\": \"\",\n \"is_active\": \"\",\n \"is_deleted\": \"\",\n \"deleted_at\": \"\",\n \"custom_field_1\": \"\",\n \"custom_field_2\": \"\",\n \"custom_field_3\": \"\",\n \"custom_field_4\": \"\",\n \"custom_field_5\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"supplier_location\": [\n {\n \"supplier_location_id\": \"\",\n \"supplier_id\": \"\",\n \"location_code\": \"\",\n \"location_name\": \"\",\n \"organization_code\": \"\",\n \"site_purpose\": \"\",\n \"default_currency_code\": \"\",\n \"default_payment_term_code\": \"\",\n \"default_payment_method\": \"\",\n \"taxpayer_id\": \"\",\n \"duns_number\": \"\",\n \"is_active\": \"\",\n \"custom_field_1\": \"\",\n \"custom_field_2\": \"\",\n \"custom_field_3\": \"\",\n \"custom_field_4\": \"\",\n \"custom_field_5\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"supplier_address\": [\n {\n \"supplier_location_id\": \"\",\n \"street\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"\",\n \"country_code\": \"\",\n \"custom_field_1\": \"\",\n \"custom_field_2\": \"\",\n \"custom_field_3\": \"\"\n },\n {\n \"supplier_location_id\": \"\",\n \"street\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"\",\n \"country_code\": \"\",\n \"custom_field_1\": \"\",\n \"custom_field_2\": \"\",\n \"custom_field_3\": \"\"\n }\n ],\n \"supplier_bank_account\": [\n {\n \"supplier_location_id\": \"\",\n \"bank_name\": \"\",\n \"bank_branch\": \"\",\n \"bank_account_number\": \"\",\n \"bank_routing_number\": \"\",\n \"swift_code\": \"\",\n \"account_currency\": \"\",\n \"is_primary\": \"\",\n \"custom_field_1\": \"\",\n \"custom_field_2\": \"\",\n \"custom_field_3\": \"\"\n },\n {\n \"supplier_location_id\": \"\",\n \"bank_name\": \"\",\n \"bank_branch\": \"\",\n \"bank_account_number\": \"\",\n \"bank_routing_number\": \"\",\n \"swift_code\": \"\",\n \"account_currency\": \"\",\n \"is_primary\": \"\",\n \"custom_field_1\": \"\",\n \"custom_field_2\": \"\",\n \"custom_field_3\": \"\"\n }\n ]\n },\n {\n \"supplier_location_id\": \"\",\n \"supplier_id\": \"\",\n \"location_code\": \"\",\n \"location_name\": \"\",\n \"organization_code\": \"\",\n \"site_purpose\": \"\",\n \"default_currency_code\": \"\",\n \"default_payment_term_code\": \"\",\n \"default_payment_method\": \"\",\n \"taxpayer_id\": \"\",\n \"duns_number\": \"\",\n \"is_active\": \"\",\n \"custom_field_1\": \"\",\n \"custom_field_2\": \"\",\n \"custom_field_3\": \"\",\n \"custom_field_4\": \"\",\n \"custom_field_5\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"supplier_address\": [\n {\n \"supplier_location_id\": \"\",\n \"street\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"\",\n \"country_code\": \"\",\n \"custom_field_1\": \"\",\n \"custom_field_2\": \"\",\n \"custom_field_3\": \"\"\n },\n {\n \"supplier_location_id\": \"\",\n \"street\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"\",\n \"country_code\": \"\",\n \"custom_field_1\": \"\",\n \"custom_field_2\": \"\",\n \"custom_field_3\": \"\"\n }\n ],\n \"supplier_bank_account\": [\n {\n \"supplier_location_id\": \"\",\n \"bank_name\": \"\",\n \"bank_branch\": \"\",\n \"bank_account_number\": \"\",\n \"bank_routing_number\": \"\",\n \"swift_code\": \"\",\n \"account_currency\": \"\",\n \"is_primary\": \"\",\n \"custom_field_1\": \"\",\n \"custom_field_2\": \"\",\n \"custom_field_3\": \"\"\n },\n {\n \"supplier_location_id\": \"\",\n \"bank_name\": \"\",\n \"bank_branch\": \"\",\n \"bank_account_number\": \"\",\n \"bank_routing_number\": \"\",\n \"swift_code\": \"\",\n \"account_currency\": \"\",\n \"is_primary\": \"\",\n \"custom_field_1\": \"\",\n \"custom_field_2\": \"\",\n \"custom_field_3\": \"\"\n }\n ]\n }\n ]\n },\n {\n \"supplier_number\": \"\",\n \"supplier_name\": \"\",\n \"supplier_id\": \"\",\n \"alternative_supplier_name\": \"\",\n \"supplier_type\": \"\",\n \"organization_code\": \"\",\n \"is_active\": \"\",\n \"is_deleted\": \"\",\n \"deleted_at\": \"\",\n \"custom_field_1\": \"\",\n \"custom_field_2\": \"\",\n \"custom_field_3\": \"\",\n \"custom_field_4\": \"\",\n \"custom_field_5\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"supplier_location\": [\n {\n \"supplier_location_id\": \"\",\n \"supplier_id\": \"\",\n \"location_code\": \"\",\n \"location_name\": \"\",\n \"organization_code\": \"\",\n \"site_purpose\": \"\",\n \"default_currency_code\": \"\",\n \"default_payment_term_code\": \"\",\n \"default_payment_method\": \"\",\n \"taxpayer_id\": \"\",\n \"duns_number\": \"\",\n \"is_active\": \"\",\n \"custom_field_1\": \"\",\n \"custom_field_2\": \"\",\n \"custom_field_3\": \"\",\n \"custom_field_4\": \"\",\n \"custom_field_5\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"supplier_address\": [\n {\n \"supplier_location_id\": \"\",\n \"street\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"\",\n \"country_code\": \"\",\n \"custom_field_1\": \"\",\n \"custom_field_2\": \"\",\n \"custom_field_3\": \"\"\n },\n {\n \"supplier_location_id\": \"\",\n \"street\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"\",\n \"country_code\": \"\",\n \"custom_field_1\": \"\",\n \"custom_field_2\": \"\",\n \"custom_field_3\": \"\"\n }\n ],\n \"supplier_bank_account\": [\n {\n \"supplier_location_id\": \"\",\n \"bank_name\": \"\",\n \"bank_branch\": \"\",\n \"bank_account_number\": \"\",\n \"bank_routing_number\": \"\",\n \"swift_code\": \"\",\n \"account_currency\": \"\",\n \"is_primary\": \"\",\n \"custom_field_1\": \"\",\n \"custom_field_2\": \"\",\n \"custom_field_3\": \"\"\n },\n {\n \"supplier_location_id\": \"\",\n \"bank_name\": \"\",\n \"bank_branch\": \"\",\n \"bank_account_number\": \"\",\n \"bank_routing_number\": \"\",\n \"swift_code\": \"\",\n \"account_currency\": \"\",\n \"is_primary\": \"\",\n \"custom_field_1\": \"\",\n \"custom_field_2\": \"\",\n \"custom_field_3\": \"\"\n }\n ]\n },\n {\n \"supplier_location_id\": \"\",\n \"supplier_id\": \"\",\n \"location_code\": \"\",\n \"location_name\": \"\",\n \"organization_code\": \"\",\n \"site_purpose\": \"\",\n \"default_currency_code\": \"\",\n \"default_payment_term_code\": \"\",\n \"default_payment_method\": \"\",\n \"taxpayer_id\": \"\",\n \"duns_number\": \"\",\n \"is_active\": \"\",\n \"custom_field_1\": \"\",\n \"custom_field_2\": \"\",\n \"custom_field_3\": \"\",\n \"custom_field_4\": \"\",\n \"custom_field_5\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"supplier_address\": [\n {\n \"supplier_location_id\": \"\",\n \"street\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"\",\n \"country_code\": \"\",\n \"custom_field_1\": \"\",\n \"custom_field_2\": \"\",\n \"custom_field_3\": \"\"\n },\n {\n \"supplier_location_id\": \"\",\n \"street\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"\",\n \"country_code\": \"\",\n \"custom_field_1\": \"\",\n \"custom_field_2\": \"\",\n \"custom_field_3\": \"\"\n }\n ],\n \"supplier_bank_account\": [\n {\n \"supplier_location_id\": \"\",\n \"bank_name\": \"\",\n \"bank_branch\": \"\",\n \"bank_account_number\": \"\",\n \"bank_routing_number\": \"\",\n \"swift_code\": \"\",\n \"account_currency\": \"\",\n \"is_primary\": \"\",\n \"custom_field_1\": \"\",\n \"custom_field_2\": \"\",\n \"custom_field_3\": \"\"\n },\n {\n \"supplier_location_id\": \"\",\n \"bank_name\": \"\",\n \"bank_branch\": \"\",\n \"bank_account_number\": \"\",\n \"bank_routing_number\": \"\",\n \"swift_code\": \"\",\n \"account_currency\": \"\",\n \"is_primary\": \"\",\n \"custom_field_1\": \"\",\n \"custom_field_2\": \"\",\n \"custom_field_3\": \"\"\n }\n ]\n }\n ]\n }\n]", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"Validation error\",\n \"message\": \"Record 0: Missing required field: supplier_number\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "78df7884-2466-42c3-abbd-89545ea3b583", "name": "Unauthorized - invalid or missing API key", "originalRequest": { "url": { "path": [ "v1", "supplier" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "full_load", "value": "false" }, { "key": "SupplierAddressInsertOnly", "value": "false" }, { "key": "SupplierBankInsertOnly", "value": "false" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "[\n {\n \"supplier_number\": \"\",\n \"supplier_name\": \"\",\n \"supplier_id\": \"\",\n \"alternative_supplier_name\": \"\",\n \"supplier_type\": \"\",\n \"organization_code\": \"\",\n \"is_active\": \"\",\n \"is_deleted\": \"\",\n \"deleted_at\": \"\",\n \"custom_field_1\": \"\",\n \"custom_field_2\": \"\",\n \"custom_field_3\": \"\",\n \"custom_field_4\": \"\",\n \"custom_field_5\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"supplier_location\": [\n {\n \"supplier_location_id\": \"\",\n \"supplier_id\": \"\",\n \"location_code\": \"\",\n \"location_name\": \"\",\n \"organization_code\": \"\",\n \"site_purpose\": \"\",\n \"default_currency_code\": \"\",\n \"default_payment_term_code\": \"\",\n \"default_payment_method\": \"\",\n \"taxpayer_id\": \"\",\n \"duns_number\": \"\",\n \"is_active\": \"\",\n \"custom_field_1\": \"\",\n \"custom_field_2\": \"\",\n \"custom_field_3\": \"\",\n \"custom_field_4\": \"\",\n \"custom_field_5\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"supplier_address\": [\n {\n \"supplier_location_id\": \"\",\n \"street\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"\",\n \"country_code\": \"\",\n \"custom_field_1\": \"\",\n \"custom_field_2\": \"\",\n \"custom_field_3\": \"\"\n },\n {\n \"supplier_location_id\": \"\",\n \"street\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"\",\n \"country_code\": \"\",\n \"custom_field_1\": \"\",\n \"custom_field_2\": \"\",\n \"custom_field_3\": \"\"\n }\n ],\n \"supplier_bank_account\": [\n {\n \"supplier_location_id\": \"\",\n \"bank_name\": \"\",\n \"bank_branch\": \"\",\n \"bank_account_number\": \"\",\n \"bank_routing_number\": \"\",\n \"swift_code\": \"\",\n \"account_currency\": \"\",\n \"is_primary\": \"\",\n \"custom_field_1\": \"\",\n \"custom_field_2\": \"\",\n \"custom_field_3\": \"\"\n },\n {\n \"supplier_location_id\": \"\",\n \"bank_name\": \"\",\n \"bank_branch\": \"\",\n \"bank_account_number\": \"\",\n \"bank_routing_number\": \"\",\n \"swift_code\": \"\",\n \"account_currency\": \"\",\n \"is_primary\": \"\",\n \"custom_field_1\": \"\",\n \"custom_field_2\": \"\",\n \"custom_field_3\": \"\"\n }\n ]\n },\n {\n \"supplier_location_id\": \"\",\n \"supplier_id\": \"\",\n \"location_code\": \"\",\n \"location_name\": \"\",\n \"organization_code\": \"\",\n \"site_purpose\": \"\",\n \"default_currency_code\": \"\",\n \"default_payment_term_code\": \"\",\n \"default_payment_method\": \"\",\n \"taxpayer_id\": \"\",\n \"duns_number\": \"\",\n \"is_active\": \"\",\n \"custom_field_1\": \"\",\n \"custom_field_2\": \"\",\n \"custom_field_3\": \"\",\n \"custom_field_4\": \"\",\n \"custom_field_5\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"supplier_address\": [\n {\n \"supplier_location_id\": \"\",\n \"street\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"\",\n \"country_code\": \"\",\n \"custom_field_1\": \"\",\n \"custom_field_2\": \"\",\n \"custom_field_3\": \"\"\n },\n {\n \"supplier_location_id\": \"\",\n \"street\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"\",\n \"country_code\": \"\",\n \"custom_field_1\": \"\",\n \"custom_field_2\": \"\",\n \"custom_field_3\": \"\"\n }\n ],\n \"supplier_bank_account\": [\n {\n \"supplier_location_id\": \"\",\n \"bank_name\": \"\",\n \"bank_branch\": \"\",\n \"bank_account_number\": \"\",\n \"bank_routing_number\": \"\",\n \"swift_code\": \"\",\n \"account_currency\": \"\",\n \"is_primary\": \"\",\n \"custom_field_1\": \"\",\n \"custom_field_2\": \"\",\n \"custom_field_3\": \"\"\n },\n {\n \"supplier_location_id\": \"\",\n \"bank_name\": \"\",\n \"bank_branch\": \"\",\n \"bank_account_number\": \"\",\n \"bank_routing_number\": \"\",\n \"swift_code\": \"\",\n \"account_currency\": \"\",\n \"is_primary\": \"\",\n \"custom_field_1\": \"\",\n \"custom_field_2\": \"\",\n \"custom_field_3\": \"\"\n }\n ]\n }\n ]\n },\n {\n \"supplier_number\": \"\",\n \"supplier_name\": \"\",\n \"supplier_id\": \"\",\n \"alternative_supplier_name\": \"\",\n \"supplier_type\": \"\",\n \"organization_code\": \"\",\n \"is_active\": \"\",\n \"is_deleted\": \"\",\n \"deleted_at\": \"\",\n \"custom_field_1\": \"\",\n \"custom_field_2\": \"\",\n \"custom_field_3\": \"\",\n \"custom_field_4\": \"\",\n \"custom_field_5\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"supplier_location\": [\n {\n \"supplier_location_id\": \"\",\n \"supplier_id\": \"\",\n \"location_code\": \"\",\n \"location_name\": \"\",\n \"organization_code\": \"\",\n \"site_purpose\": \"\",\n \"default_currency_code\": \"\",\n \"default_payment_term_code\": \"\",\n \"default_payment_method\": \"\",\n \"taxpayer_id\": \"\",\n \"duns_number\": \"\",\n \"is_active\": \"\",\n \"custom_field_1\": \"\",\n \"custom_field_2\": \"\",\n \"custom_field_3\": \"\",\n \"custom_field_4\": \"\",\n \"custom_field_5\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"supplier_address\": [\n {\n \"supplier_location_id\": \"\",\n \"street\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"\",\n \"country_code\": \"\",\n \"custom_field_1\": \"\",\n \"custom_field_2\": \"\",\n \"custom_field_3\": \"\"\n },\n {\n \"supplier_location_id\": \"\",\n \"street\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"\",\n \"country_code\": \"\",\n \"custom_field_1\": \"\",\n \"custom_field_2\": \"\",\n \"custom_field_3\": \"\"\n }\n ],\n \"supplier_bank_account\": [\n {\n \"supplier_location_id\": \"\",\n \"bank_name\": \"\",\n \"bank_branch\": \"\",\n \"bank_account_number\": \"\",\n \"bank_routing_number\": \"\",\n \"swift_code\": \"\",\n \"account_currency\": \"\",\n \"is_primary\": \"\",\n \"custom_field_1\": \"\",\n \"custom_field_2\": \"\",\n \"custom_field_3\": \"\"\n },\n {\n \"supplier_location_id\": \"\",\n \"bank_name\": \"\",\n \"bank_branch\": \"\",\n \"bank_account_number\": \"\",\n \"bank_routing_number\": \"\",\n \"swift_code\": \"\",\n \"account_currency\": \"\",\n \"is_primary\": \"\",\n \"custom_field_1\": \"\",\n \"custom_field_2\": \"\",\n \"custom_field_3\": \"\"\n }\n ]\n },\n {\n \"supplier_location_id\": \"\",\n \"supplier_id\": \"\",\n \"location_code\": \"\",\n \"location_name\": \"\",\n \"organization_code\": \"\",\n \"site_purpose\": \"\",\n \"default_currency_code\": \"\",\n \"default_payment_term_code\": \"\",\n \"default_payment_method\": \"\",\n \"taxpayer_id\": \"\",\n \"duns_number\": \"\",\n \"is_active\": \"\",\n \"custom_field_1\": \"\",\n \"custom_field_2\": \"\",\n \"custom_field_3\": \"\",\n \"custom_field_4\": \"\",\n \"custom_field_5\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"supplier_address\": [\n {\n \"supplier_location_id\": \"\",\n \"street\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"\",\n \"country_code\": \"\",\n \"custom_field_1\": \"\",\n \"custom_field_2\": \"\",\n \"custom_field_3\": \"\"\n },\n {\n \"supplier_location_id\": \"\",\n \"street\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"\",\n \"country_code\": \"\",\n \"custom_field_1\": \"\",\n \"custom_field_2\": \"\",\n \"custom_field_3\": \"\"\n }\n ],\n \"supplier_bank_account\": [\n {\n \"supplier_location_id\": \"\",\n \"bank_name\": \"\",\n \"bank_branch\": \"\",\n \"bank_account_number\": \"\",\n \"bank_routing_number\": \"\",\n \"swift_code\": \"\",\n \"account_currency\": \"\",\n \"is_primary\": \"\",\n \"custom_field_1\": \"\",\n \"custom_field_2\": \"\",\n \"custom_field_3\": \"\"\n },\n {\n \"supplier_location_id\": \"\",\n \"bank_name\": \"\",\n \"bank_branch\": \"\",\n \"bank_account_number\": \"\",\n \"bank_routing_number\": \"\",\n \"swift_code\": \"\",\n \"account_currency\": \"\",\n \"is_primary\": \"\",\n \"custom_field_1\": \"\",\n \"custom_field_2\": \"\",\n \"custom_field_3\": \"\"\n }\n ]\n }\n ]\n }\n]", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"Unauthorized\",\n \"message\": \"API key is required\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5fd970b1-522a-4025-b437-f36c9236d0f9", "name": "Forbidden - insufficient permissions", "originalRequest": { "url": { "path": [ "v1", "supplier" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "full_load", "value": "false" }, { "key": "SupplierAddressInsertOnly", "value": "false" }, { "key": "SupplierBankInsertOnly", "value": "false" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "[\n {\n \"supplier_number\": \"\",\n \"supplier_name\": \"\",\n \"supplier_id\": \"\",\n \"alternative_supplier_name\": \"\",\n \"supplier_type\": \"\",\n \"organization_code\": \"\",\n \"is_active\": \"\",\n \"is_deleted\": \"\",\n \"deleted_at\": \"\",\n \"custom_field_1\": \"\",\n \"custom_field_2\": \"\",\n \"custom_field_3\": \"\",\n \"custom_field_4\": \"\",\n \"custom_field_5\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"supplier_location\": [\n {\n \"supplier_location_id\": \"\",\n \"supplier_id\": \"\",\n \"location_code\": \"\",\n \"location_name\": \"\",\n \"organization_code\": \"\",\n \"site_purpose\": \"\",\n \"default_currency_code\": \"\",\n \"default_payment_term_code\": \"\",\n \"default_payment_method\": \"\",\n \"taxpayer_id\": \"\",\n \"duns_number\": \"\",\n \"is_active\": \"\",\n \"custom_field_1\": \"\",\n \"custom_field_2\": \"\",\n \"custom_field_3\": \"\",\n \"custom_field_4\": \"\",\n \"custom_field_5\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"supplier_address\": [\n {\n \"supplier_location_id\": \"\",\n \"street\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"\",\n \"country_code\": \"\",\n \"custom_field_1\": \"\",\n \"custom_field_2\": \"\",\n \"custom_field_3\": \"\"\n },\n {\n \"supplier_location_id\": \"\",\n \"street\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"\",\n \"country_code\": \"\",\n \"custom_field_1\": \"\",\n \"custom_field_2\": \"\",\n \"custom_field_3\": \"\"\n }\n ],\n \"supplier_bank_account\": [\n {\n \"supplier_location_id\": \"\",\n \"bank_name\": \"\",\n \"bank_branch\": \"\",\n \"bank_account_number\": \"\",\n \"bank_routing_number\": \"\",\n \"swift_code\": \"\",\n \"account_currency\": \"\",\n \"is_primary\": \"\",\n \"custom_field_1\": \"\",\n \"custom_field_2\": \"\",\n \"custom_field_3\": \"\"\n },\n {\n \"supplier_location_id\": \"\",\n \"bank_name\": \"\",\n \"bank_branch\": \"\",\n \"bank_account_number\": \"\",\n \"bank_routing_number\": \"\",\n \"swift_code\": \"\",\n \"account_currency\": \"\",\n \"is_primary\": \"\",\n \"custom_field_1\": \"\",\n \"custom_field_2\": \"\",\n \"custom_field_3\": \"\"\n }\n ]\n },\n {\n \"supplier_location_id\": \"\",\n \"supplier_id\": \"\",\n \"location_code\": \"\",\n \"location_name\": \"\",\n \"organization_code\": \"\",\n \"site_purpose\": \"\",\n \"default_currency_code\": \"\",\n \"default_payment_term_code\": \"\",\n \"default_payment_method\": \"\",\n \"taxpayer_id\": \"\",\n \"duns_number\": \"\",\n \"is_active\": \"\",\n \"custom_field_1\": \"\",\n \"custom_field_2\": \"\",\n \"custom_field_3\": \"\",\n \"custom_field_4\": \"\",\n \"custom_field_5\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"supplier_address\": [\n {\n \"supplier_location_id\": \"\",\n \"street\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"\",\n \"country_code\": \"\",\n \"custom_field_1\": \"\",\n \"custom_field_2\": \"\",\n \"custom_field_3\": \"\"\n },\n {\n \"supplier_location_id\": \"\",\n \"street\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"\",\n \"country_code\": \"\",\n \"custom_field_1\": \"\",\n \"custom_field_2\": \"\",\n \"custom_field_3\": \"\"\n }\n ],\n \"supplier_bank_account\": [\n {\n \"supplier_location_id\": \"\",\n \"bank_name\": \"\",\n \"bank_branch\": \"\",\n \"bank_account_number\": \"\",\n \"bank_routing_number\": \"\",\n \"swift_code\": \"\",\n \"account_currency\": \"\",\n \"is_primary\": \"\",\n \"custom_field_1\": \"\",\n \"custom_field_2\": \"\",\n \"custom_field_3\": \"\"\n },\n {\n \"supplier_location_id\": \"\",\n \"bank_name\": \"\",\n \"bank_branch\": \"\",\n \"bank_account_number\": \"\",\n \"bank_routing_number\": \"\",\n \"swift_code\": \"\",\n \"account_currency\": \"\",\n \"is_primary\": \"\",\n \"custom_field_1\": \"\",\n \"custom_field_2\": \"\",\n \"custom_field_3\": \"\"\n }\n ]\n }\n ]\n },\n {\n \"supplier_number\": \"\",\n \"supplier_name\": \"\",\n \"supplier_id\": \"\",\n \"alternative_supplier_name\": \"\",\n \"supplier_type\": \"\",\n \"organization_code\": \"\",\n \"is_active\": \"\",\n \"is_deleted\": \"\",\n \"deleted_at\": \"\",\n \"custom_field_1\": \"\",\n \"custom_field_2\": \"\",\n \"custom_field_3\": \"\",\n \"custom_field_4\": \"\",\n \"custom_field_5\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"supplier_location\": [\n {\n \"supplier_location_id\": \"\",\n \"supplier_id\": \"\",\n \"location_code\": \"\",\n \"location_name\": \"\",\n \"organization_code\": \"\",\n \"site_purpose\": \"\",\n \"default_currency_code\": \"\",\n \"default_payment_term_code\": \"\",\n \"default_payment_method\": \"\",\n \"taxpayer_id\": \"\",\n \"duns_number\": \"\",\n \"is_active\": \"\",\n \"custom_field_1\": \"\",\n \"custom_field_2\": \"\",\n \"custom_field_3\": \"\",\n \"custom_field_4\": \"\",\n \"custom_field_5\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"supplier_address\": [\n {\n \"supplier_location_id\": \"\",\n \"street\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"\",\n \"country_code\": \"\",\n \"custom_field_1\": \"\",\n \"custom_field_2\": \"\",\n \"custom_field_3\": \"\"\n },\n {\n \"supplier_location_id\": \"\",\n \"street\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"\",\n \"country_code\": \"\",\n \"custom_field_1\": \"\",\n \"custom_field_2\": \"\",\n \"custom_field_3\": \"\"\n }\n ],\n \"supplier_bank_account\": [\n {\n \"supplier_location_id\": \"\",\n \"bank_name\": \"\",\n \"bank_branch\": \"\",\n \"bank_account_number\": \"\",\n \"bank_routing_number\": \"\",\n \"swift_code\": \"\",\n \"account_currency\": \"\",\n \"is_primary\": \"\",\n \"custom_field_1\": \"\",\n \"custom_field_2\": \"\",\n \"custom_field_3\": \"\"\n },\n {\n \"supplier_location_id\": \"\",\n \"bank_name\": \"\",\n \"bank_branch\": \"\",\n \"bank_account_number\": \"\",\n \"bank_routing_number\": \"\",\n \"swift_code\": \"\",\n \"account_currency\": \"\",\n \"is_primary\": \"\",\n \"custom_field_1\": \"\",\n \"custom_field_2\": \"\",\n \"custom_field_3\": \"\"\n }\n ]\n },\n {\n \"supplier_location_id\": \"\",\n \"supplier_id\": \"\",\n \"location_code\": \"\",\n \"location_name\": \"\",\n \"organization_code\": \"\",\n \"site_purpose\": \"\",\n \"default_currency_code\": \"\",\n \"default_payment_term_code\": \"\",\n \"default_payment_method\": \"\",\n \"taxpayer_id\": \"\",\n \"duns_number\": \"\",\n \"is_active\": \"\",\n \"custom_field_1\": \"\",\n \"custom_field_2\": \"\",\n \"custom_field_3\": \"\",\n \"custom_field_4\": \"\",\n \"custom_field_5\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"supplier_address\": [\n {\n \"supplier_location_id\": \"\",\n \"street\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"\",\n \"country_code\": \"\",\n \"custom_field_1\": \"\",\n \"custom_field_2\": \"\",\n \"custom_field_3\": \"\"\n },\n {\n \"supplier_location_id\": \"\",\n \"street\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"\",\n \"country_code\": \"\",\n \"custom_field_1\": \"\",\n \"custom_field_2\": \"\",\n \"custom_field_3\": \"\"\n }\n ],\n \"supplier_bank_account\": [\n {\n \"supplier_location_id\": \"\",\n \"bank_name\": \"\",\n \"bank_branch\": \"\",\n \"bank_account_number\": \"\",\n \"bank_routing_number\": \"\",\n \"swift_code\": \"\",\n \"account_currency\": \"\",\n \"is_primary\": \"\",\n \"custom_field_1\": \"\",\n \"custom_field_2\": \"\",\n \"custom_field_3\": \"\"\n },\n {\n \"supplier_location_id\": \"\",\n \"bank_name\": \"\",\n \"bank_branch\": \"\",\n \"bank_account_number\": \"\",\n \"bank_routing_number\": \"\",\n \"swift_code\": \"\",\n \"account_currency\": \"\",\n \"is_primary\": \"\",\n \"custom_field_1\": \"\",\n \"custom_field_2\": \"\",\n \"custom_field_3\": \"\"\n }\n ]\n }\n ]\n }\n]", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"Forbidden\",\n \"message\": \"API user does not have required permissions: POST_SUPPLIER, POST_DATA\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8d0499e7-044e-4159-bb8b-27477664c39d", "name": "Internal server error", "originalRequest": { "url": { "path": [ "v1", "supplier" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "full_load", "value": "false" }, { "key": "SupplierAddressInsertOnly", "value": "false" }, { "key": "SupplierBankInsertOnly", "value": "false" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "[\n {\n \"supplier_number\": \"\",\n \"supplier_name\": \"\",\n \"supplier_id\": \"\",\n \"alternative_supplier_name\": \"\",\n \"supplier_type\": \"\",\n \"organization_code\": \"\",\n \"is_active\": \"\",\n \"is_deleted\": \"\",\n \"deleted_at\": \"\",\n \"custom_field_1\": \"\",\n \"custom_field_2\": \"\",\n \"custom_field_3\": \"\",\n \"custom_field_4\": \"\",\n \"custom_field_5\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"supplier_location\": [\n {\n \"supplier_location_id\": \"\",\n \"supplier_id\": \"\",\n \"location_code\": \"\",\n \"location_name\": \"\",\n \"organization_code\": \"\",\n \"site_purpose\": \"\",\n \"default_currency_code\": \"\",\n \"default_payment_term_code\": \"\",\n \"default_payment_method\": \"\",\n \"taxpayer_id\": \"\",\n \"duns_number\": \"\",\n \"is_active\": \"\",\n \"custom_field_1\": \"\",\n \"custom_field_2\": \"\",\n \"custom_field_3\": \"\",\n \"custom_field_4\": \"\",\n \"custom_field_5\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"supplier_address\": [\n {\n \"supplier_location_id\": \"\",\n \"street\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"\",\n \"country_code\": \"\",\n \"custom_field_1\": \"\",\n \"custom_field_2\": \"\",\n \"custom_field_3\": \"\"\n },\n {\n \"supplier_location_id\": \"\",\n \"street\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"\",\n \"country_code\": \"\",\n \"custom_field_1\": \"\",\n \"custom_field_2\": \"\",\n \"custom_field_3\": \"\"\n }\n ],\n \"supplier_bank_account\": [\n {\n \"supplier_location_id\": \"\",\n \"bank_name\": \"\",\n \"bank_branch\": \"\",\n \"bank_account_number\": \"\",\n \"bank_routing_number\": \"\",\n \"swift_code\": \"\",\n \"account_currency\": \"\",\n \"is_primary\": \"\",\n \"custom_field_1\": \"\",\n \"custom_field_2\": \"\",\n \"custom_field_3\": \"\"\n },\n {\n \"supplier_location_id\": \"\",\n \"bank_name\": \"\",\n \"bank_branch\": \"\",\n \"bank_account_number\": \"\",\n \"bank_routing_number\": \"\",\n \"swift_code\": \"\",\n \"account_currency\": \"\",\n \"is_primary\": \"\",\n \"custom_field_1\": \"\",\n \"custom_field_2\": \"\",\n \"custom_field_3\": \"\"\n }\n ]\n },\n {\n \"supplier_location_id\": \"\",\n \"supplier_id\": \"\",\n \"location_code\": \"\",\n \"location_name\": \"\",\n \"organization_code\": \"\",\n \"site_purpose\": \"\",\n \"default_currency_code\": \"\",\n \"default_payment_term_code\": \"\",\n \"default_payment_method\": \"\",\n \"taxpayer_id\": \"\",\n \"duns_number\": \"\",\n \"is_active\": \"\",\n \"custom_field_1\": \"\",\n \"custom_field_2\": \"\",\n \"custom_field_3\": \"\",\n \"custom_field_4\": \"\",\n \"custom_field_5\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"supplier_address\": [\n {\n \"supplier_location_id\": \"\",\n \"street\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"\",\n \"country_code\": \"\",\n \"custom_field_1\": \"\",\n \"custom_field_2\": \"\",\n \"custom_field_3\": \"\"\n },\n {\n \"supplier_location_id\": \"\",\n \"street\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"\",\n \"country_code\": \"\",\n \"custom_field_1\": \"\",\n \"custom_field_2\": \"\",\n \"custom_field_3\": \"\"\n }\n ],\n \"supplier_bank_account\": [\n {\n \"supplier_location_id\": \"\",\n \"bank_name\": \"\",\n \"bank_branch\": \"\",\n \"bank_account_number\": \"\",\n \"bank_routing_number\": \"\",\n \"swift_code\": \"\",\n \"account_currency\": \"\",\n \"is_primary\": \"\",\n \"custom_field_1\": \"\",\n \"custom_field_2\": \"\",\n \"custom_field_3\": \"\"\n },\n {\n \"supplier_location_id\": \"\",\n \"bank_name\": \"\",\n \"bank_branch\": \"\",\n \"bank_account_number\": \"\",\n \"bank_routing_number\": \"\",\n \"swift_code\": \"\",\n \"account_currency\": \"\",\n \"is_primary\": \"\",\n \"custom_field_1\": \"\",\n \"custom_field_2\": \"\",\n \"custom_field_3\": \"\"\n }\n ]\n }\n ]\n },\n {\n \"supplier_number\": \"\",\n \"supplier_name\": \"\",\n \"supplier_id\": \"\",\n \"alternative_supplier_name\": \"\",\n \"supplier_type\": \"\",\n \"organization_code\": \"\",\n \"is_active\": \"\",\n \"is_deleted\": \"\",\n \"deleted_at\": \"\",\n \"custom_field_1\": \"\",\n \"custom_field_2\": \"\",\n \"custom_field_3\": \"\",\n \"custom_field_4\": \"\",\n \"custom_field_5\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"supplier_location\": [\n {\n \"supplier_location_id\": \"\",\n \"supplier_id\": \"\",\n \"location_code\": \"\",\n \"location_name\": \"\",\n \"organization_code\": \"\",\n \"site_purpose\": \"\",\n \"default_currency_code\": \"\",\n \"default_payment_term_code\": \"\",\n \"default_payment_method\": \"\",\n \"taxpayer_id\": \"\",\n \"duns_number\": \"\",\n \"is_active\": \"\",\n \"custom_field_1\": \"\",\n \"custom_field_2\": \"\",\n \"custom_field_3\": \"\",\n \"custom_field_4\": \"\",\n \"custom_field_5\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"supplier_address\": [\n {\n \"supplier_location_id\": \"\",\n \"street\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"\",\n \"country_code\": \"\",\n \"custom_field_1\": \"\",\n \"custom_field_2\": \"\",\n \"custom_field_3\": \"\"\n },\n {\n \"supplier_location_id\": \"\",\n \"street\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"\",\n \"country_code\": \"\",\n \"custom_field_1\": \"\",\n \"custom_field_2\": \"\",\n \"custom_field_3\": \"\"\n }\n ],\n \"supplier_bank_account\": [\n {\n \"supplier_location_id\": \"\",\n \"bank_name\": \"\",\n \"bank_branch\": \"\",\n \"bank_account_number\": \"\",\n \"bank_routing_number\": \"\",\n \"swift_code\": \"\",\n \"account_currency\": \"\",\n \"is_primary\": \"\",\n \"custom_field_1\": \"\",\n \"custom_field_2\": \"\",\n \"custom_field_3\": \"\"\n },\n {\n \"supplier_location_id\": \"\",\n \"bank_name\": \"\",\n \"bank_branch\": \"\",\n \"bank_account_number\": \"\",\n \"bank_routing_number\": \"\",\n \"swift_code\": \"\",\n \"account_currency\": \"\",\n \"is_primary\": \"\",\n \"custom_field_1\": \"\",\n \"custom_field_2\": \"\",\n \"custom_field_3\": \"\"\n }\n ]\n },\n {\n \"supplier_location_id\": \"\",\n \"supplier_id\": \"\",\n \"location_code\": \"\",\n \"location_name\": \"\",\n \"organization_code\": \"\",\n \"site_purpose\": \"\",\n \"default_currency_code\": \"\",\n \"default_payment_term_code\": \"\",\n \"default_payment_method\": \"\",\n \"taxpayer_id\": \"\",\n \"duns_number\": \"\",\n \"is_active\": \"\",\n \"custom_field_1\": \"\",\n \"custom_field_2\": \"\",\n \"custom_field_3\": \"\",\n \"custom_field_4\": \"\",\n \"custom_field_5\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"supplier_address\": [\n {\n \"supplier_location_id\": \"\",\n \"street\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"\",\n \"country_code\": \"\",\n \"custom_field_1\": \"\",\n \"custom_field_2\": \"\",\n \"custom_field_3\": \"\"\n },\n {\n \"supplier_location_id\": \"\",\n \"street\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"\",\n \"country_code\": \"\",\n \"custom_field_1\": \"\",\n \"custom_field_2\": \"\",\n \"custom_field_3\": \"\"\n }\n ],\n \"supplier_bank_account\": [\n {\n \"supplier_location_id\": \"\",\n \"bank_name\": \"\",\n \"bank_branch\": \"\",\n \"bank_account_number\": \"\",\n \"bank_routing_number\": \"\",\n \"swift_code\": \"\",\n \"account_currency\": \"\",\n \"is_primary\": \"\",\n \"custom_field_1\": \"\",\n \"custom_field_2\": \"\",\n \"custom_field_3\": \"\"\n },\n {\n \"supplier_location_id\": \"\",\n \"bank_name\": \"\",\n \"bank_branch\": \"\",\n \"bank_account_number\": \"\",\n \"bank_routing_number\": \"\",\n \"swift_code\": \"\",\n \"account_currency\": \"\",\n \"is_primary\": \"\",\n \"custom_field_1\": \"\",\n \"custom_field_2\": \"\",\n \"custom_field_3\": \"\"\n }\n ]\n }\n ]\n }\n]", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"Internal server error\",\n \"message\": \"Failed to insert suppliers\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5729c15d-fad5-4059-8449-f4737169bb1e", "name": "Delete suppliers", "request": { "name": "Delete suppliers", "description": { "content": "\nSoft delete or deactivate suppliers based on filter criteria.\n\n**Actions**:\n- **delete**: Sets is_deleted = true (soft delete)\n- **deactivate**: Sets is_active = false\n\n**Filter Parameters**: Supports filtering by supplier ID, number, organization code, and dates\n ", "type": "text/plain" }, "url": { "path": [ "v1", "supplier" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"action\": \"\",\n \"parameters\": [\n {\n \"supplier_id\": \"\",\n \"supplier_number\": \"\",\n \"organization_code\": \"\",\n \"created_before_date\": \"\",\n \"created_after_date\": \"\",\n \"updated_before_date\": \"\",\n \"updated_after_date\": \"\"\n },\n {\n \"supplier_id\": \"\",\n \"supplier_number\": \"\",\n \"organization_code\": \"\",\n \"created_before_date\": \"\",\n \"created_after_date\": \"\",\n \"updated_before_date\": \"\",\n \"updated_after_date\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "8aba6b36-18dc-4261-b881-25e03f70c893", "name": "Suppliers updated (deleted or deactivated)", "originalRequest": { "url": { "path": [ "v1", "supplier" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"action\": \"\",\n \"parameters\": [\n {\n \"supplier_id\": \"\",\n \"supplier_number\": \"\",\n \"organization_code\": \"\",\n \"created_before_date\": \"\",\n \"created_after_date\": \"\",\n \"updated_before_date\": \"\",\n \"updated_after_date\": \"\"\n },\n {\n \"supplier_id\": \"\",\n \"supplier_number\": \"\",\n \"organization_code\": \"\",\n \"created_before_date\": \"\",\n \"created_after_date\": \"\",\n \"updated_before_date\": \"\",\n \"updated_after_date\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Suppliers deleted successfully\",\n \"supplierIds\": [\n \"978033c9-4e0f-153e-0893-850b6c3d8724\",\n \"c23fcdbb-6640-bfec-65a7-50d249342d0f\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1a7a2293-b0d8-47e3-8c15-10ff86ee11c9", "name": "Bad request - invalid action or parameters", "originalRequest": { "url": { "path": [ "v1", "supplier" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"action\": \"\",\n \"parameters\": [\n {\n \"supplier_id\": \"\",\n \"supplier_number\": \"\",\n \"organization_code\": \"\",\n \"created_before_date\": \"\",\n \"created_after_date\": \"\",\n \"updated_before_date\": \"\",\n \"updated_after_date\": \"\"\n },\n {\n \"supplier_id\": \"\",\n \"supplier_number\": \"\",\n \"organization_code\": \"\",\n \"created_before_date\": \"\",\n \"created_after_date\": \"\",\n \"updated_before_date\": \"\",\n \"updated_after_date\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"Validation error\",\n \"message\": \"Action must be either \\\"delete\\\" or \\\"deactivate\\\"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cf60de28-0021-4590-ae83-d3768df06278", "name": "Unauthorized - invalid or missing API key", "originalRequest": { "url": { "path": [ "v1", "supplier" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"action\": \"\",\n \"parameters\": [\n {\n \"supplier_id\": \"\",\n \"supplier_number\": \"\",\n \"organization_code\": \"\",\n \"created_before_date\": \"\",\n \"created_after_date\": \"\",\n \"updated_before_date\": \"\",\n \"updated_after_date\": \"\"\n },\n {\n \"supplier_id\": \"\",\n \"supplier_number\": \"\",\n \"organization_code\": \"\",\n \"created_before_date\": \"\",\n \"created_after_date\": \"\",\n \"updated_before_date\": \"\",\n \"updated_after_date\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"Unauthorized\",\n \"message\": \"API key is required\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2b57efd5-7086-43f2-9aff-edf6a0808520", "name": "Forbidden - insufficient permissions", "originalRequest": { "url": { "path": [ "v1", "supplier" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"action\": \"\",\n \"parameters\": [\n {\n \"supplier_id\": \"\",\n \"supplier_number\": \"\",\n \"organization_code\": \"\",\n \"created_before_date\": \"\",\n \"created_after_date\": \"\",\n \"updated_before_date\": \"\",\n \"updated_after_date\": \"\"\n },\n {\n \"supplier_id\": \"\",\n \"supplier_number\": \"\",\n \"organization_code\": \"\",\n \"created_before_date\": \"\",\n \"created_after_date\": \"\",\n \"updated_before_date\": \"\",\n \"updated_after_date\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"Forbidden\",\n \"message\": \"API user does not have required permissions: POST_SUPPLIER, POST_DATA\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "408f7e1b-fa07-41df-8637-794d765201fa", "name": "Internal server error", "originalRequest": { "url": { "path": [ "v1", "supplier" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"action\": \"\",\n \"parameters\": [\n {\n \"supplier_id\": \"\",\n \"supplier_number\": \"\",\n \"organization_code\": \"\",\n \"created_before_date\": \"\",\n \"created_after_date\": \"\",\n \"updated_before_date\": \"\",\n \"updated_after_date\": \"\"\n },\n {\n \"supplier_id\": \"\",\n \"supplier_number\": \"\",\n \"organization_code\": \"\",\n \"created_before_date\": \"\",\n \"created_after_date\": \"\",\n \"updated_before_date\": \"\",\n \"updated_after_date\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"Internal server error\",\n \"message\": \"Failed to delete suppliers\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "d5c4a388-bda2-4f36-8201-f7afb8bbc070", "name": "User", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "00df42e1-cf39-411c-bf7d-7141c4b52456", "name": "List users", "request": { "name": "List users", "description": { "content": "Returns a paginated list of users in the tenant. Group memberships are returned as `groups: [{ external_code, name }]`. Password hashes are never returned. The `sso_subject` column is internal and is not exposed.", "type": "text/plain" }, "url": { "path": [ "v1", "users" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "key": "page", "value": "1", "description": "Page number for pagination" }, { "disabled": true, "key": "limit", "value": "1000", "description": "Number of records per page (max 1000)" }, { "disabled": true, "key": "id", "value": "", "description": "Filter by exact user id" }, { "disabled": true, "key": "email", "value": "", "description": "Filter by email (ILIKE)" }, { "disabled": true, "key": "login_account", "value": "", "description": "Filter by exact login_account" }, { "disabled": true, "key": "name", "value": "", "description": "Filter by first_name OR last_name (ILIKE)" }, { "disabled": true, "key": "is_active", "value": "", "description": "Filter by active status" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "c87d1474-16ba-4e2b-951a-e4ecbff1df7d", "name": "List of users with group memberships", "originalRequest": { "url": { "path": [ "v1", "users" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "limit", "value": "1000" }, { "key": "id", "value": "" }, { "key": "email", "value": "" }, { "key": "login_account", "value": "" }, { "key": "name", "value": "" }, { "key": "is_active", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"count\": 7902,\n \"page\": 9666,\n \"totalPages\": 284,\n \"users\": [\n {\n \"first_name\": \"string\",\n \"last_name\": \"string\",\n \"email\": \"le2ILksudJF4h@OMSICuQRyzwlTiSFStzYIEUSQpx.lsw\",\n \"login_account\": \"string\",\n \"login_type\": 1,\n \"id\": 9115,\n \"sso_provider\": \"string\",\n \"is_active\": false,\n \"active_from\": \"1975-01-08T13:58:23.894Z\",\n \"active_to\": \"2013-08-01T02:46:00.022Z\",\n \"must_change_password\": false,\n \"groups\": [\n {\n \"external_code\": \"FINANCE\",\n \"name\": \"Finance Team\"\n },\n {\n \"external_code\": \"AP_TEAM\",\n \"name\": \"Accounts Payable\"\n }\n ],\n \"created_at\": \"1967-09-20T21:15:59.032Z\",\n \"updated_at\": \"1954-08-10T12:03:58.435Z\"\n },\n {\n \"first_name\": \"string\",\n \"last_name\": \"string\",\n \"email\": \"bFXdl@OdVSUXDdPiBtsLYrLH.luru\",\n \"login_account\": \"string\",\n \"login_type\": 2,\n \"id\": 8819,\n \"sso_provider\": \"string\",\n \"is_active\": false,\n \"active_from\": \"1988-07-31T17:13:49.709Z\",\n \"active_to\": \"2003-09-27T15:38:30.252Z\",\n \"must_change_password\": false,\n \"groups\": [\n {\n \"external_code\": \"FINANCE\",\n \"name\": \"Finance Team\"\n },\n {\n \"external_code\": \"AP_TEAM\",\n \"name\": \"Accounts Payable\"\n }\n ],\n \"created_at\": \"2024-05-30T22:11:07.642Z\",\n \"updated_at\": \"1999-02-11T00:19:58.433Z\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f45c6967-18b2-416b-b950-451e09acd6aa", "name": "Unauthorized — invalid or missing API key", "originalRequest": { "url": { "path": [ "v1", "users" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "limit", "value": "1000" }, { "key": "id", "value": "" }, { "key": "email", "value": "" }, { "key": "login_account", "value": "" }, { "key": "name", "value": "" }, { "key": "is_active", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"string\",\n \"code\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9eacc1c8-9195-42cb-9d94-9429a131c8a9", "name": "Forbidden — insufficient permissions (READ_USER or READ_DATA required)", "originalRequest": { "url": { "path": [ "v1", "users" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "limit", "value": "1000" }, { "key": "id", "value": "" }, { "key": "email", "value": "" }, { "key": "login_account", "value": "" }, { "key": "name", "value": "" }, { "key": "is_active", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"string\",\n \"code\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ad936c3d-ef37-458a-9ae4-709da56ab9ca", "name": "Internal server error", "originalRequest": { "url": { "path": [ "v1", "users" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "limit", "value": "1000" }, { "key": "id", "value": "" }, { "key": "email", "value": "" }, { "key": "login_account", "value": "" }, { "key": "name", "value": "" }, { "key": "is_active", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"string\",\n \"code\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "12c668c3-fe66-4578-a93c-48fa6cf49d49", "name": "Bulk upsert users", "request": { "name": "Bulk upsert users", "description": { "content": "\nBulk-upsert users. **Upsert key: `login_account`.** Plain-text passwords are hashed by the API before storage; if you omit the `password` field, the existing hash is preserved. When you supply a password, `must_change_password` is set to true so the user is forced to rotate it on first sign-in.\n\n**Group memberships** use the same `groups` shape returned by GET — an array of `{ external_code }` objects. Any `name` field sent is ignored. Replace-all semantics — the array on POST fully defines the user's memberships after the call. Omit the field entirely to leave memberships untouched. Send `[]` to clear all memberships. Codes that don't match any `user_groups.external_code` return 400 with the offending list.\n\n**Email** is UNIQUE per tenant. If a payload's `email` conflicts with a different existing `login_account`, the call returns 409 with details before any write happens.\n\n**Required fields**: first_name, last_name, email, login_account, login_type. `login_type=2` (SSO) additionally requires `sso_provider` (the `alias` from `idp_sso_config`).\n\n**No `full_load`**: bulk replacement is deliberately not supported. To kill stale users automatically, use POST /users/deactivate-inactive.\n\n**Max** 1000 users per request.\n\nUnknown fields (e.g. `sso_subject`) are silently ignored.\n ", "type": "text/plain" }, "url": { "path": [ "v1", "users" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "[\n {\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"email\": \"\",\n \"login_account\": \"\",\n \"login_type\": \"\",\n \"password\": \"\",\n \"sso_provider\": \"\",\n \"is_active\": \"\",\n \"active_from\": \"\",\n \"active_to\": \"\",\n \"groups\": [\n {\n \"external_code\": \"\"\n },\n {\n \"external_code\": \"\"\n }\n ]\n },\n {\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"email\": \"\",\n \"login_account\": \"\",\n \"login_type\": \"\",\n \"password\": \"\",\n \"sso_provider\": \"\",\n \"is_active\": \"\",\n \"active_from\": \"\",\n \"active_to\": \"\",\n \"groups\": [\n {\n \"external_code\": \"\"\n },\n {\n \"external_code\": \"\"\n }\n ]\n }\n]", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "bdb00fa3-8216-433b-9148-dd7de34d53ca", "name": "Users upserted successfully", "originalRequest": { "url": { "path": [ "v1", "users" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "[\n {\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"email\": \"jane.doe@example.com\",\n \"login_account\": \"jane.doe\",\n \"login_type\": 1,\n \"password\": \"TempPassw0rd!\",\n \"is_active\": true,\n \"groups\": [\n {\n \"external_code\": \"FINANCE\"\n },\n {\n \"external_code\": \"AP_TEAM\"\n }\n ]\n },\n {\n \"first_name\": \"John\",\n \"last_name\": \"Smith\",\n \"email\": \"john.smith@example.com\",\n \"login_account\": \"john.smith\",\n \"login_type\": 2,\n \"sso_provider\": \"nuntiq\",\n \"is_active\": true,\n \"groups\": [\n {\n \"external_code\": \"AP_TEAM\"\n }\n ]\n }\n]", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"string\",\n \"usersUpserted\": 9714\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "55c23a3f-2613-4f1f-94b9-0e90377b9ea6", "name": "Validation error or unknown group external_codes", "originalRequest": { "url": { "path": [ "v1", "users" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "[\n {\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"email\": \"jane.doe@example.com\",\n \"login_account\": \"jane.doe\",\n \"login_type\": 1,\n \"password\": \"TempPassw0rd!\",\n \"is_active\": true,\n \"groups\": [\n {\n \"external_code\": \"FINANCE\"\n },\n {\n \"external_code\": \"AP_TEAM\"\n }\n ]\n },\n {\n \"first_name\": \"John\",\n \"last_name\": \"Smith\",\n \"email\": \"john.smith@example.com\",\n \"login_account\": \"john.smith\",\n \"login_type\": 2,\n \"sso_provider\": \"nuntiq\",\n \"is_active\": true,\n \"groups\": [\n {\n \"external_code\": \"AP_TEAM\"\n }\n ]\n }\n]", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"string\",\n \"code\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "56764245-b4cf-4c0c-9cf1-04c817ff2896", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1", "users" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "[\n {\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"email\": \"jane.doe@example.com\",\n \"login_account\": \"jane.doe\",\n \"login_type\": 1,\n \"password\": \"TempPassw0rd!\",\n \"is_active\": true,\n \"groups\": [\n {\n \"external_code\": \"FINANCE\"\n },\n {\n \"external_code\": \"AP_TEAM\"\n }\n ]\n },\n {\n \"first_name\": \"John\",\n \"last_name\": \"Smith\",\n \"email\": \"john.smith@example.com\",\n \"login_account\": \"john.smith\",\n \"login_type\": 2,\n \"sso_provider\": \"nuntiq\",\n \"is_active\": true,\n \"groups\": [\n {\n \"external_code\": \"AP_TEAM\"\n }\n ]\n }\n]", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"string\",\n \"code\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d63b9811-1eca-497c-9957-e912fc3c11db", "name": "Forbidden — insufficient permissions (POST_USER or POST_DATA required)", "originalRequest": { "url": { "path": [ "v1", "users" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "[\n {\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"email\": \"jane.doe@example.com\",\n \"login_account\": \"jane.doe\",\n \"login_type\": 1,\n \"password\": \"TempPassw0rd!\",\n \"is_active\": true,\n \"groups\": [\n {\n \"external_code\": \"FINANCE\"\n },\n {\n \"external_code\": \"AP_TEAM\"\n }\n ]\n },\n {\n \"first_name\": \"John\",\n \"last_name\": \"Smith\",\n \"email\": \"john.smith@example.com\",\n \"login_account\": \"john.smith\",\n \"login_type\": 2,\n \"sso_provider\": \"nuntiq\",\n \"is_active\": true,\n \"groups\": [\n {\n \"external_code\": \"AP_TEAM\"\n }\n ]\n }\n]", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"string\",\n \"code\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ecac4488-6a49-4cf0-b48f-70fc657121da", "name": "Email conflict with existing row under a different login_account", "originalRequest": { "url": { "path": [ "v1", "users" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "[\n {\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"email\": \"jane.doe@example.com\",\n \"login_account\": \"jane.doe\",\n \"login_type\": 1,\n \"password\": \"TempPassw0rd!\",\n \"is_active\": true,\n \"groups\": [\n {\n \"external_code\": \"FINANCE\"\n },\n {\n \"external_code\": \"AP_TEAM\"\n }\n ]\n },\n {\n \"first_name\": \"John\",\n \"last_name\": \"Smith\",\n \"email\": \"john.smith@example.com\",\n \"login_account\": \"john.smith\",\n \"login_type\": 2,\n \"sso_provider\": \"nuntiq\",\n \"is_active\": true,\n \"groups\": [\n {\n \"external_code\": \"AP_TEAM\"\n }\n ]\n }\n]", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"string\",\n \"code\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1b5903b6-476c-49e8-9987-b369487bb411", "name": "Internal server error", "originalRequest": { "url": { "path": [ "v1", "users" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "[\n {\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"email\": \"jane.doe@example.com\",\n \"login_account\": \"jane.doe\",\n \"login_type\": 1,\n \"password\": \"TempPassw0rd!\",\n \"is_active\": true,\n \"groups\": [\n {\n \"external_code\": \"FINANCE\"\n },\n {\n \"external_code\": \"AP_TEAM\"\n }\n ]\n },\n {\n \"first_name\": \"John\",\n \"last_name\": \"Smith\",\n \"email\": \"john.smith@example.com\",\n \"login_account\": \"john.smith\",\n \"login_type\": 2,\n \"sso_provider\": \"nuntiq\",\n \"is_active\": true,\n \"groups\": [\n {\n \"external_code\": \"AP_TEAM\"\n }\n ]\n }\n]", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"string\",\n \"code\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "bff2e1f5-1751-4407-9505-2c0fa873957f", "name": "Delete user", "request": { "name": "Delete user", "description": { "content": "Sets `is_active = false` and `active_to = NOW()`. Row stays in the table so audit history remains readable. Re-deletes are idempotent: re-deactivating an already-inactive user returns 200, not 404.", "type": "text/plain" }, "url": { "path": [ "v1", "users" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"login_account\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "a965a63f-38cd-45cf-b2ba-ec393ec5c677", "name": "User deactivated", "originalRequest": { "url": { "path": [ "v1", "users" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"login_account\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"string\",\n \"userId\": 7034,\n \"login_account\": \"string\",\n \"active_to\": \"1954-09-28T10:03:30.391Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fbe87ab5-c429-45df-b821-487df5eefe2f", "name": "Missing login_account", "originalRequest": { "url": { "path": [ "v1", "users" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"login_account\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"string\",\n \"code\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "123d13ab-84ec-4cb7-8d06-26f4b9ef5b33", "name": "User not found", "originalRequest": { "url": { "path": [ "v1", "users" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"login_account\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"string\",\n \"code\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d737afaf-1d6f-4339-a8fa-239bb75a77eb", "name": "Deactivate inactive users", "request": { "name": "Deactivate inactive users", "description": { "content": "\nSweep deactivation for stale accounts. A user is deactivated when **all** of:\n\n- `created_at` is older than `days` days ago (so brand-new accounts that haven't had a chance to log in yet are not killed).\n- They have **no** `login_success` row in `authentication_audit_log` within the last `days` days. **Impersonation logins are excluded** (rows where `impersonation_session_id IS NOT NULL` don't count).\n- Their `login_account` is not in `exclude_login_accounts`.\n- They are currently `is_active = true` (already-inactive users are skipped).\n\nAffected users get `is_active=false` and `active_to=NOW()` — same as DELETE /users.\n\nThe response includes up to 1000 affected users with `last_login_at` (NULL if they've never logged in). If more were affected, `truncated: true` is set on the response.\n\nUse `dry_run: true` to see who would be deactivated without writing anything.\n ", "type": "text/plain" }, "url": { "path": [ "v1", "users", "deactivate-inactive" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"days\": \"\",\n \"exclude_login_accounts\": [\n \"\",\n \"\"\n ],\n \"dry_run\": false\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "c06a778d-df82-49ba-ba4d-824486f0497d", "name": "Sweep completed", "originalRequest": { "url": { "path": [ "v1", "users", "deactivate-inactive" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"days\": 90,\n \"exclude_login_accounts\": [\n \"svc-erp\",\n \"svc-edi\"\n ],\n \"dry_run\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"deactivated\": [\n {\n \"id\": 8142,\n \"login_account\": \"string\",\n \"email\": \"string\",\n \"last_login_at\": \"1990-01-03T11:50:23.121Z\"\n },\n {\n \"id\": 8721,\n \"login_account\": \"string\",\n \"email\": \"string\",\n \"last_login_at\": \"1969-06-14T14:02:10.313Z\"\n }\n ],\n \"count\": 5952,\n \"truncated\": true,\n \"dry_run\": true,\n \"days\": 180\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "851c2298-e97e-4bd2-a8e0-3bb2234447f2", "name": "Validation error (missing/invalid days, etc.)", "originalRequest": { "url": { "path": [ "v1", "users", "deactivate-inactive" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"days\": 90,\n \"exclude_login_accounts\": [\n \"svc-erp\",\n \"svc-edi\"\n ],\n \"dry_run\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"string\",\n \"code\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f6cbc8f1-34d4-4b2c-9de6-c5e060d760ea", "name": "Forbidden — insufficient permissions (POST_USER or POST_DATA required)", "originalRequest": { "url": { "path": [ "v1", "users", "deactivate-inactive" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"days\": 90,\n \"exclude_login_accounts\": [\n \"svc-erp\",\n \"svc-edi\"\n ],\n \"dry_run\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"string\",\n \"code\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] } ], "event": [], "variable": [ { "key": "baseUrl", "value": "https://dev-api.apreceiving.com/api", "type": "string", "description": "API host + /api base path. Swap to https://test-api.apreceiving.com/api or https://api.apreceiving.com/api." }, { "key": "apiKey", "value": "", "type": "string", "description": "Your customer API key. Sent as X-API-Key on every request." } ], "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "info": { "_postman_id": "3c01ed55-53f9-49f0-88c9-770b00293c30", "name": "Nuntiq Customer API", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": "Customer API for Nuntiq tenant integrations: invoice import, attachments, suppliers, purchase orders, receipts, organizations, users, payments, lifecycle messages and delta state.\n\nAuth: send your customer API key in the `X-API-Key` header. The key is set once at collection level (Authorization tab) and inherited by every request, so fill in the `apiKey` variable and nothing else.\n\nPartner / supplier endpoints are intentionally NOT in this collection — they use a different credential. Import the \"Nuntiq Supplier / Partner API\" collection for those.\n\nThe `baseUrl` variable defaults to the development host. Point it at test-api / api when you are ready." } }