{ "info": { "_postman_id": "43c1343b-47ad-489d-9325-6a707092c7d9", "name": "AzoraOne - API", "description": "Offer your customers automation of data entry from financial documents and categorization of incoming files.", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "_exporter_id": "6890236", "_collection_link": "https://go.postman.co/collection/6890236-43c1343b-47ad-489d-9325-6a707092c7d9?source=collection_link" }, "item": [ { "name": "Companies", "item": [ { "name": "Add a company", "request": { "method": "POST", "header": [ { "key": "Client-Key", "value": "{{clientKey}}", "description": "(Required) Your unique client key." }, { "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}", "description": "(Required) Your unique subscription key." }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\r\n \"companyID\": \"1\",\r\n \"companyName\": \"SmallCorp\",\r\n \"companyProxy\": \"Account Group Inc\",\r\n \"active\": true,\r\n \"precognition\": {\r\n \"active\": false\r\n },\r\n \"corporateIdentityNumber\": \"556754-9273\",\r\n \"bankAccountNumber\": \"310-6093\",\r\n \"plusGiroNumber\": \"477451-9\",\r\n \"iban\": \"\",\r\n \"vatNumber\": \"SE556754927301\",\r\n \"countryOfOrigin\": \"SE\"\r\n}" }, "url": { "raw": "{{baseUrl}}/companies", "host": [ "{{baseUrl}}" ], "path": [ "companies" ] }, "description": "Add a company." }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "key": "Client-Key", "value": "{{clientKey}}", "description": "(Required) Your unique client key." }, { "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}", "description": "(Required) Your unique subscription key." }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"companyID\": \"1\",\n \"companyName\": \"SmallCorp\",\n \"companyProxy\": \"Account Group Inc\",\n \"active\": true,\n \"precognition\": {\n \"active\": false\n },\n \"corporateIdentityNumber\": \"556754-9273\",\n \"bankAccountNumber\": \"310-6093\",\n \"plusGiroNumber\": \"477451-9\",\n \"iban\": \"\",\n \"vatNumber\": \"SE556754927301\",\n \"countryOfOrigin\": \"SE\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/companies", "host": [ "{{baseUrl}}" ], "path": [ "companies" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\r\n \"success\": true,\r\n \"data\": {\r\n \"companyID\": \"1\",\r\n \"companyName\": \"SmallCorp\",\r\n \"companyProxy\": \"Account Group Inc\",\r\n \"active\": true,\r\n \"precognition\": {\r\n \"active\": false\r\n },\r\n \"corporateIdentityNumber\": \"556754-9273\",\r\n \"bankAccountNumber\": \"310-6093\",\r\n \"plusGiroNumber\": \"477451-9\",\r\n \"iban\": \"\",\r\n \"vatNumber\": \"SE556754927301\",\r\n \"countryOfOrigin\": \"SE\",\r\n \"createdDate\": \"\",\r\n \"metrics\": null\r\n },\r\n \"extended\": \"\",\r\n \"meta\": \"\",\r\n \"origin\": \"\",\r\n \"time\": \"2020-10-26 11:35:54\"\r\n}" }, { "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "key": "Client-Key", "value": "{{clientKey}}", "description": "(Required) Your unique client key." }, { "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}", "description": "(Required) Your unique subscription key." }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"companyID\": \"1\",\n \"companyName\": \"SmallCorp\",\n \"companyProxy\": \"Account Group Inc\",\n \"active\": true,\n \"precognition\": {\n \"active\": false\n },\n \"corporateIdentityNumber\": \"556754-9273\",\n \"bankAccountNumber\": \"310-6093\",\n \"plusGiroNumber\": \"477451-9\",\n \"iban\": \"\",\n \"vatNumber\": \"SE556754927301\",\n \"countryOfOrigin\": \"SE\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/companies", "host": [ "{{baseUrl}}" ], "path": [ "companies" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\r\n \"success\": false,\r\n \"data\": [\r\n {\r\n \"code\": 111402,\r\n \"message\": \"Company ID is not valid.\",\r\n \"details\": \"\",\r\n \"element\": \"companyID\"\r\n },\r\n {\r\n \"code\": 113102,\r\n \"message\": \"Corporate identity number is not valid.\",\r\n \"details\": \"\",\r\n \"element\": \"corporateIdentityNumber\"\r\n }\r\n ],\r\n \"extended\": \"\",\r\n \"meta\": \"\",\r\n \"origin\": \"\",\r\n \"time\": \"2020-08-02 06:45:42\"\r\n}" }, { "name": "Internal Server Error", "originalRequest": { "method": "POST", "header": [ { "key": "Client-Key", "value": "{{clientKey}}", "description": "(Required) Your unique client key." }, { "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}", "description": "(Required) Your unique subscription key." }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"companyID\": \"1\",\n \"companyName\": \"SmallCorp\",\n \"companyProxy\": \"Account Group Inc\",\n \"active\": true,\n \"precognition\": {\n \"active\": false\n },\n \"corporateIdentityNumber\": \"556754-9273\",\n \"bankAccountNumber\": \"310-6093\",\n \"plusGiroNumber\": \"477451-9\",\n \"iban\": \"\",\n \"vatNumber\": \"SE556754927301\",\n \"countryOfOrigin\": \"SE\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/companies", "host": [ "{{baseUrl}}" ], "path": [ "companies" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\r\n \"success\": false,\r\n \"data\": [\r\n {\r\n \"code\": 1009220,\r\n \"message\": \"Database operation failed.\",\r\n \"details\": \"\",\r\n \"element\": \"\"\r\n }\r\n ],\r\n \"extended\": \"\",\r\n \"meta\": \"\",\r\n \"origin\": \"\",\r\n \"time\": \"2020-08-02 06:40:59\"\r\n}" } ] }, { "name": "Retrieve a company", "request": { "method": "GET", "header": [ { "key": "Client-Key", "value": "{{clientKey}}", "description": "(Required) Your unique client key." }, { "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}", "description": "(Required) Your unique subscription key." } ], "url": { "raw": "{{baseUrl}}/companies/:companyID", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID" ], "query": [ { "key": "metrics", "value": "true", "description": "When set to true, metrics will be returned", "disabled": true }, { "key": "conformityFilters", "value": "supplier, accounts", "description": "A comma-separated list of specific fields to filter conformity against. Can be used in conjunction with metrics to assess conformity on particular dimensions such as description, conformity, accounts, etc.", "disabled": true }, { "key": "fileCreatedFrom", "value": "2025-05-01 00:00:00", "description": "The start date and time (inclusive) for filtering files based on their creation date. Format: YYYY-MM-DD HH:mm:ss.", "disabled": true }, { "key": "fileCreatedTo", "value": "2025-07-01 00:00:00", "description": "The end date and time(inclusive) for filtering files based on their creation date. Format: YYYY-MM-DD HH:mm:ss", "disabled": true }, { "key": "fileFormat", "value": "xml", "description": "The format/extension of files to filter. Allowed value: pdf, xml, png, or jpg.", "disabled": true } ], "variable": [ { "key": "companyID", "value": "1", "description": "(Required) The company's unique ID." } ] }, "description": "Retrieve a company." }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Client-Key", "value": "{{clientKey}}", "description": "(Required) Your unique client key." }, { "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}", "description": "(Required) Your unique subscription key." } ], "url": { "raw": "{{baseUrl}}/companies/:companyID?metrics=true", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID" ], "query": [ { "key": "metrics", "value": "true" }, { "key": "conformityFilters", "value": null, "disabled": true }, { "key": "fileCreatedFrom", "value": null, "disabled": true }, { "key": "fileCreatedTo", "value": null, "disabled": true }, { "key": "fileFormat", "value": null, "disabled": true } ], "variable": [ { "key": "companyID", "value": "1" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\r\n \"success\": true,\r\n \"data\": {\r\n \"companyID\": \"1\",\r\n \"companyName\": \"SmallCorp\",\r\n \"companyProxy\": \"Account Group Inc\",\r\n \"active\": true,\r\n \"precognition\": {\r\n \"active\": false\r\n },\r\n \"corporateIdentityNumber\": \"556754-9273\",\r\n \"bankAccountNumber\": \"310-6093\",\r\n \"plusGiroNumber\": \"477451-9\",\r\n \"iban\": \"\",\r\n \"vatNumber\": \"SE556754927301\",\r\n \"countryOfOrigin\": \"SE\",\r\n \"metrics\": {\r\n \"files\": {\r\n \"uploadedCount\": 1582,\r\n \"extractedCount\": 1566,\r\n \"bookedCount\": 1396,\r\n \"extractedAndBookedCount\": 1393,\r\n \"extractedByBricksCount\": 51,\r\n \"averageConformity\": 80.87,\r\n \"types\": [\r\n {\r\n \"type\": \"SupplierInvoice\",\r\n \"averageConformity\": 89.97,\r\n \"extractedCount\": 355,\r\n \"bookedCount\": 296,\r\n \"extractedAndBookedCount\": 296\r\n },\r\n {\r\n \"type\": \"Receipt\",\r\n \"averageConformity\": 78.23,\r\n \"extractedCount\": 1211,\r\n \"bookedCount\": 1100,\r\n \"extractedAndBookedCount\": 1097\r\n }\r\n ]\r\n },\r\n \"bricks\": null\r\n }\r\n },\r\n \"extended\": \"\",\r\n \"meta\": {\r\n \"created\": \"2026-08-05 08:37:45\",\r\n \"subscriptionStart\": \"2026-08-05 08:37:46\",\r\n \"lastActivated\": \"2026-08-05 08:37:46\",\r\n \"lastDeactivated\": \"\",\r\n \"cycleLength\": \"0100\",\r\n \"cycleEnd\": \"2026-09-05 08:37:46\",\r\n \"lastDebited\": \"\",\r\n \"debitable\": true,\r\n \"pagination\": null,\r\n \"updated\": \"2026-08-05 08:38:32\"\r\n },\r\n \"origin\": \"\",\r\n \"time\": \"2020-10-30 11:37:36\"\r\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "key": "Client-Key", "value": "{{clientKey}}", "description": "(Required) Your unique client key." }, { "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}", "description": "(Required) Your unique subscription key." } ], "url": { "raw": "{{baseUrl}}/companies/:companyID?metrics=true", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID" ], "query": [ { "key": "metrics", "value": "true" }, { "key": "conformityFilters", "value": null, "disabled": true }, { "key": "fileCreatedFrom", "value": null, "disabled": true }, { "key": "fileCreatedTo", "value": null, "disabled": true }, { "key": "fileFormat", "value": null, "disabled": true } ], "variable": [ { "key": "companyID", "value": "1" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\r\n \"success\": false,\r\n \"data\": [\r\n {\r\n \"code\": 111402,\r\n \"message\": \"Company ID is not valid.\",\r\n \"details\": \"\",\r\n \"element\": \"companyID\"\r\n }\r\n ],\r\n \"extended\": \"\",\r\n \"meta\": \"\",\r\n \"origin\": \"\",\r\n \"time\": \"2020-08-02 06:45:42\"\r\n}" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "key": "Client-Key", "value": "{{clientKey}}", "description": "(Required) Your unique client key." }, { "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}", "description": "(Required) Your unique subscription key." } ], "url": { "raw": "{{baseUrl}}/companies/:companyID?metrics=true", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID" ], "query": [ { "key": "metrics", "value": "true" }, { "key": "conformityFilters", "value": null, "disabled": true }, { "key": "fileCreatedFrom", "value": null, "disabled": true }, { "key": "fileCreatedTo", "value": null, "disabled": true }, { "key": "fileFormat", "value": null, "disabled": true } ], "variable": [ { "key": "companyID", "value": "1" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\r\n \"success\": false,\r\n \"data\": [\r\n {\r\n \"code\": 111401,\r\n \"message\": \"Company ID not found.\",\r\n \"details\": \"\",\r\n \"element\": \"companyID\"\r\n }\r\n ],\r\n \"extended\": \"\",\r\n \"meta\": \"\",\r\n \"origin\": \"\",\r\n \"time\": \"2020-08-02 06:44:18\"\r\n}" }, { "name": "Internal Server Error", "originalRequest": { "method": "GET", "header": [ { "key": "Client-Key", "value": "{{clientKey}}", "description": "(Required) Your unique client key." }, { "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}", "description": "(Required) Your unique subscription key." } ], "url": { "raw": "{{baseUrl}}/companies/:companyID?metrics=true", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID" ], "query": [ { "key": "metrics", "value": "true" }, { "key": "conformityFilters", "value": null, "disabled": true }, { "key": "fileCreatedFrom", "value": null, "disabled": true }, { "key": "fileCreatedTo", "value": null, "disabled": true }, { "key": "fileFormat", "value": null, "disabled": true } ], "variable": [ { "key": "companyID", "value": "1" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\r\n \"success\": false,\r\n \"data\": [\r\n {\r\n \"code\": 1009220,\r\n \"message\": \"Database operation failed.\",\r\n \"details\": \"\",\r\n \"element\": \"\"\r\n }\r\n ],\r\n \"extended\": \"\",\r\n \"meta\": \"\",\r\n \"origin\": \"\",\r\n \"time\": \"2020-07-22 06:52:33\"\r\n}" } ] }, { "name": "Retrieve all companies", "request": { "method": "GET", "header": [ { "key": "Client-Key", "value": "{{clientKey}}", "description": "(Required) Your unique client key." }, { "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}", "description": "(Required) Your unique subscription key." } ], "url": { "raw": "{{baseUrl}}/companies", "host": [ "{{baseUrl}}" ], "path": [ "companies" ], "query": [ { "key": "active", "value": "", "description": "When set to true, only active companies will be returned", "disabled": true }, { "key": "createdFrom", "value": "2025-05-01 00:00:00", "description": "The start date and time(inclusive) for filtering companies based on their creation date. Format: YYYY-MM-DD HH:mm:ss.", "disabled": true }, { "key": "createdTo", "value": "2025-08-01 00:00:00", "description": "The end date and time (inclusive) for filtering companies based on their creation date. Format: YYYY-MM-DD HH:mm:ss", "disabled": true }, { "key": "metrics", "value": "true", "description": "When set to true, metrics will be returned. You must page through the result set (e.g. pageNumber, pageSize) with metrics=true", "disabled": true }, { "key": "conformityFilters", "value": "supplier, accounts", "description": "A comma-separated list of specific fields to filter conformity against. Can be used in conjunction with metrics to assess conformity on particular dimensions such as description, conformity, accounts, etc.", "disabled": true }, { "key": "fileCreatedFrom", "value": "2025-05-01 00:00:00", "description": "The start date and time (inclusive) for filtering files based on their creation date. Format: YYYY-MM-DD HH:mm:ss.", "disabled": true }, { "key": "fileCreatedTo", "value": "2025-08-01 00:00:00", "description": "The end date and time (inclusive) for filtering files based on their creation date. Format: YYYY-MM-DD HH:mm:ss", "disabled": true }, { "key": "fileFormat", "value": "xml", "description": "The format/extension of files to filter. Allowed value: pdf, xml, png, or jpg.", "disabled": true }, { "key": "pageNumber", "value": "1", "description": "The page number of the result set to retrieve. Starts at 1.", "disabled": true }, { "key": "pageSize", "value": "2", "description": "Specifies how many items to return on each page of results.Max Allowed value is 30", "disabled": true }, { "key": "sortField", "value": "CreatedDateUTC", "description": "The field by which to sort the result set. Allowed values: 'CompanyID' (default), 'CompanyName', 'CompanyProxy', 'CreatedDateUTC', 'CountryOfOrigin'.", "disabled": true }, { "key": "sortDirection", "value": "desc", "description": "The order in which results are sorted. Accepted values: 'asc' for ascending, 'desc' for descending. Defaults to ascending if not specified.", "disabled": true } ] }, "description": "Retrieve all companies." }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Client-Key", "value": "{{clientKey}}", "description": "(Required) Your unique client key." }, { "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}", "description": "(Required) Your unique subscription key." } ], "url": { "raw": "{{baseUrl}}/companies?metrics=true", "host": [ "{{baseUrl}}" ], "path": [ "companies" ], "query": [ { "key": "active", "value": null, "disabled": true }, { "key": "createdFrom", "value": null, "disabled": true }, { "key": "createdTo", "value": null, "disabled": true }, { "key": "metrics", "value": "true" }, { "key": "conformityFilters", "value": null, "disabled": true }, { "key": "fileCreatedFrom", "value": null, "disabled": true }, { "key": "fileCreatedTo", "value": null, "disabled": true }, { "key": "fileFormat", "value": null, "disabled": true }, { "key": "pageNumber", "value": "1", "disabled": true }, { "key": "pageSize", "value": "2", "disabled": true }, { "key": "sortField", "value": null, "disabled": true }, { "key": "sortDirection", "value": null, "disabled": true } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\r\n \"success\": true,\r\n \"data\": {\r\n \"companies\": [\r\n {\r\n \"companyID\": \"1\",\r\n \"companyName\": \"SmallCorp\",\r\n \"companyProxy\": \"Account Group Inc\",\r\n \"active\": true,\r\n \"precognition\": {\r\n \"active\": false\r\n },\r\n \"corporateIdentityNumber\": \"\",\r\n \"bankAccountNumber\": \"\",\r\n \"plusGiroNumber\": \"\",\r\n \"iban\": \"\",\r\n \"vatNumber\": \"\",\r\n \"countryOfOrigin\": \"\",\r\n \"createdDate\": \"2024-01-02 05:49:07\",\r\n \"metrics\": null\r\n },\r\n {\r\n \"companyID\": \"4\",\r\n \"companyName\": \"SmallCorp\",\r\n \"companyProxy\": \"Account Group Inc\",\r\n \"active\": true,\r\n \"precognition\": {\r\n \"active\": false\r\n },\r\n \"corporateIdentityNumber\": \"\",\r\n \"bankAccountNumber\": \"\",\r\n \"plusGiroNumber\": \"\",\r\n \"iban\": \"\",\r\n \"vatNumber\": \"\",\r\n \"countryOfOrigin\": \"\",\r\n \"createdDate\": \"2024-01-02 07:07:22\",\r\n \"metrics\": null\r\n }\r\n ]\r\n },\r\n \"extended\": \"\",\r\n \"meta\": {\r\n \"pagination\": {\r\n \"pageNumber\": 1,\r\n \"pageSize\": 5,\r\n \"totalItems\": 15,\r\n \"totalPages\": 3\r\n },\r\n \"updated\": \"2026-08-05 09:20:12\"\r\n },\r\n \"origin\": \"\",\r\n \"time\": \"2026-08-05 09:20:30\"\r\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "key": "Client-Key", "value": "{{clientKey}}", "description": "(Required) Your unique client key." }, { "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}", "description": "(Required) Your unique subscription key." } ], "url": { "raw": "{{baseUrl}}/companies?metrics=true", "host": [ "{{baseUrl}}" ], "path": [ "companies" ], "query": [ { "key": "active", "value": null, "disabled": true }, { "key": "createdFrom", "value": null, "disabled": true }, { "key": "createdTo", "value": null, "disabled": true }, { "key": "metrics", "value": "true" }, { "key": "conformityFilters", "value": null, "disabled": true }, { "key": "fileCreatedFrom", "value": null, "disabled": true }, { "key": "fileCreatedTo", "value": null, "disabled": true }, { "key": "fileFormat", "value": null, "disabled": true }, { "key": "pageNumber", "value": "1", "disabled": true }, { "key": "pageSize", "value": "2", "disabled": true }, { "key": "sortField", "value": null, "disabled": true }, { "key": "sortDirection", "value": null, "disabled": true } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\r\n \"success\": false,\r\n \"data\": [\r\n {\r\n \"code\": 101151,\r\n \"message\": \"Missing required query parameter\",\r\n \"details\": \"pageNumber is required when metrics=true\",\r\n \"element\": \"PageNumber\"\r\n },\r\n {\r\n \"code\": 101151,\r\n \"message\": \"Missing required query parameter\",\r\n \"details\": \"pageSize is required when metrics=true\",\r\n \"element\": \"PageSize\"\r\n }\r\n ],\r\n \"extended\": \"\",\r\n \"meta\": \"\",\r\n \"origin\": \"\",\r\n \"time\": \"2020-08-02 06:45:42\"\r\n}" }, { "name": "Internal Server Error", "originalRequest": { "method": "GET", "header": [ { "key": "Client-Key", "value": "{{clientKey}}", "description": "(Required) Your unique client key." }, { "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}", "description": "(Required) Your unique subscription key." } ], "url": { "raw": "{{baseUrl}}/companies?metrics=true", "host": [ "{{baseUrl}}" ], "path": [ "companies" ], "query": [ { "key": "active", "value": null, "disabled": true }, { "key": "createdFrom", "value": null, "disabled": true }, { "key": "createdTo", "value": null, "disabled": true }, { "key": "metrics", "value": "true" }, { "key": "conformityFilters", "value": null, "disabled": true }, { "key": "fileCreatedFrom", "value": null, "disabled": true }, { "key": "fileCreatedTo", "value": null, "disabled": true }, { "key": "fileFormat", "value": null, "disabled": true }, { "key": "pageNumber", "value": "1", "disabled": true }, { "key": "pageSize", "value": "2", "disabled": true }, { "key": "sortField", "value": null, "disabled": true }, { "key": "sortDirection", "value": null, "disabled": true } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\r\n \"success\": false,\r\n \"data\": [\r\n {\r\n \"code\": 1009220,\r\n \"message\": \"Database operation failed.\",\r\n \"details\": \"\",\r\n \"element\": \"\"\r\n }\r\n ],\r\n \"extended\": \"\",\r\n \"meta\": \"\",\r\n \"origin\": \"\",\r\n \"time\": \"2020-07-22 06:40:59\"\r\n}" } ] }, { "name": "Update a company", "request": { "method": "PUT", "header": [ { "key": "Client-Key", "value": "{{clientKey}}", "description": "(Required) Your unique client key." }, { "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}", "description": "(Required) Your unique subscription key." }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\r\n \"companyID\": \"1\",\r\n \"companyName\": \"SmallCorp\",\r\n \"companyProxy\": \"Account Group Inc\",\r\n \"active\": true,\r\n \"precognition\": {\r\n \"active\": false\r\n },\r\n \"corporateIdentityNumber\": \"556754-9273\",\r\n \"bankAccountNumber\": \"310-6093\",\r\n \"plusGiroNumber\": \"477451-9\",\r\n \"iban\": \"\",\r\n \"vatNumber\": \"SE556754927301\",\r\n \"countryOfOrigin\": \"SE\"\r\n}" }, "url": { "raw": "{{baseUrl}}/companies/:companyID", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID" ], "variable": [ { "key": "companyID", "value": "1", "description": "(Required) The company's unique ID." } ] }, "description": "Update a company." }, "response": [ { "name": "OK", "originalRequest": { "method": "PUT", "header": [ { "key": "Client-Key", "value": "{{clientKey}}", "description": "(Required) Your unique client key." }, { "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}", "description": "(Required) Your unique subscription key." }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"companyID\": \"1\",\n \"companyName\": \"SmallCorp\",\n \"companyProxy\": \"Account Group Inc\",\n \"active\": true,\n \"precognition\": {\n \"active\": false\n },\n \"corporateIdentityNumber\": \"556754-9273\",\n \"bankAccountNumber\": \"310-6093\",\n \"plusGiroNumber\": \"477451-9\",\n \"iban\": \"\",\n \"vatNumber\": \"SE556754927301\",\n \"countryOfOrigin\": \"SE\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/companies/:companyID", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID" ], "variable": [ { "key": "companyID", "value": "1" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\r\n \"success\": true,\r\n \"data\": {\r\n \"companyID\": \"1\",\r\n \"companyName\": \"SmallCorp\",\r\n \"companyProxy\": \"Account Group Inc\",\r\n \"active\": true,\r\n \"precognition\": {\r\n \"active\": false\r\n },\r\n \"corporateIdentityNumber\": \"556754-9273\",\r\n \"bankAccountNumber\": \"310-6093\",\r\n \"plusGiroNumber\": \"477451-9\",\r\n \"iban\": \"\",\r\n \"vatNumber\": \"SE556754927301\",\r\n \"countryOfOrigin\": \"SE\",\r\n \"createdDate\": \"\",\r\n \"metrics\": null\r\n },\r\n \"extended\": \"\",\r\n \"meta\": \"\",\r\n \"origin\": \"\",\r\n \"time\": \"2026-08-05 09:39:21\"\r\n}" }, { "name": "Bad Request", "originalRequest": { "method": "PUT", "header": [ { "key": "Client-Key", "value": "{{clientKey}}", "description": "(Required) Your unique client key." }, { "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}", "description": "(Required) Your unique subscription key." }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"companyID\": \"1\",\n \"companyName\": \"SmallCorp\",\n \"companyProxy\": \"Account Group Inc\",\n \"active\": true,\n \"precognition\": {\n \"active\": false\n },\n \"corporateIdentityNumber\": \"556754-9273\",\n \"bankAccountNumber\": \"310-6093\",\n \"plusGiroNumber\": \"477451-9\",\n \"iban\": \"\",\n \"vatNumber\": \"SE556754927301\",\n \"countryOfOrigin\": \"SE\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/companies/:companyID", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID" ], "variable": [ { "key": "companyID", "value": "1" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\r\n \"success\": false,\r\n \"data\": [\r\n {\r\n \"code\": 111402,\r\n \"message\": \"Company ID is not valid.\",\r\n \"details\": \"\",\r\n \"element\": \"companyID\"\r\n },\r\n {\r\n \"code\": 113102,\r\n \"message\": \"Corporate identity number is not valid.\",\r\n \"details\": \"\",\r\n \"element\": \"corporateIdentityNumber\"\r\n }\r\n ],\r\n \"extended\": \"\",\r\n \"meta\": \"\",\r\n \"origin\": \"\",\r\n \"time\": \"2020-08-02 06:45:42\"\r\n}" }, { "name": "Not Found", "originalRequest": { "method": "PUT", "header": [ { "key": "Client-Key", "value": "{{clientKey}}", "description": "(Required) Your unique client key." }, { "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}", "description": "(Required) Your unique subscription key." }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"companyID\": \"1\",\n \"companyName\": \"SmallCorp\",\n \"companyProxy\": \"Account Group Inc\",\n \"active\": true,\n \"precognition\": {\n \"active\": false\n },\n \"corporateIdentityNumber\": \"556754-9273\",\n \"bankAccountNumber\": \"310-6093\",\n \"plusGiroNumber\": \"477451-9\",\n \"iban\": \"\",\n \"vatNumber\": \"SE556754927301\",\n \"countryOfOrigin\": \"SE\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/companies/:companyID", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID" ], "variable": [ { "key": "companyID", "value": "1" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\r\n \"success\": false,\r\n \"data\": [\r\n {\r\n \"code\": 111401,\r\n \"message\": \"Company ID not found.\",\r\n \"details\": \"\",\r\n \"element\": \"companyID\"\r\n }\r\n ],\r\n \"extended\": \"\",\r\n \"meta\": \"\",\r\n \"origin\": \"\",\r\n \"time\": \"2020-08-02 06:44:18\"\r\n}" }, { "name": "Internal Server Error", "originalRequest": { "method": "PUT", "header": [ { "key": "Client-Key", "value": "{{clientKey}}", "description": "(Required) Your unique client key." }, { "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}", "description": "(Required) Your unique subscription key." }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"companyID\": \"1\",\n \"companyName\": \"SmallCorp\",\n \"companyProxy\": \"Account Group Inc\",\n \"active\": true,\n \"precognition\": {\n \"active\": false\n },\n \"corporateIdentityNumber\": \"556754-9273\",\n \"bankAccountNumber\": \"310-6093\",\n \"plusGiroNumber\": \"477451-9\",\n \"iban\": \"\",\n \"vatNumber\": \"SE556754927301\",\n \"countryOfOrigin\": \"SE\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/companies/:companyID", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID" ], "variable": [ { "key": "companyID", "value": "1" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\r\n \"success\": false,\r\n \"data\": [\r\n {\r\n \"code\": 1009220,\r\n \"message\": \"Database operation failed.\",\r\n \"details\": \"\",\r\n \"element\": \"\"\r\n }\r\n ],\r\n \"extended\": \"\",\r\n \"meta\": \"\",\r\n \"origin\": \"\",\r\n \"time\": \"2020-07-22 06:52:33\"\r\n}" } ] } ] }, { "name": "Files", "item": [ { "name": "Add a file", "request": { "method": "POST", "header": [ { "description": "(Required) Your unique client key.", "key": "Client-Key", "value": "{{clientKey}}" }, { "description": "(Required) Your unique subscription key.", "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}" }, { "key": "Content-Type", "value": "multipart/form-data" } ], "body": { "mode": "formdata", "formdata": [ { "key": "fileID", "value": "1", "description": "undefined", "type": "text" }, { "key": "webhookUrl", "value": "", "description": "undefined", "type": "text" }, { "key": "file", "description": "undefined", "type": "file", "value": null } ] }, "url": { "raw": "{{baseUrl}}/companies/:companyID/files", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "files" ], "variable": [ { "key": "companyID", "value": "1", "description": "(Required) The company's unique ID." } ] }, "description": "Add a file." }, "response": [ { "name": "Accepted", "originalRequest": { "method": "POST", "header": [ { "key": "Client-Key", "value": "{{clientKey}}", "description": "(Required) Your unique client key." }, { "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}", "description": "(Required) Your unique subscription key." } ], "body": { "mode": "formdata", "formdata": [ { "key": "fileID", "value": "1", "description": "undefined", "type": "text" }, { "key": "webhookUrl", "value": "", "description": "undefined", "type": "text" }, { "key": "file", "value": "{}", "description": "undefined", "type": "text" } ] }, "url": { "raw": "{{baseUrl}}/companies/:companyID/files", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "files" ], "variable": [ { "key": "companyID" } ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\r\n \"success\": true,\r\n \"data\": {\r\n \"fileID\": \"100\",\r\n \"fileName\": \"telavox.pdf\",\r\n \"status\": \"WAITING\",\r\n \"type\": \"\",\r\n \"verificationSeries\": \"\",\r\n \"createdDate\": \"\",\r\n \"conformity\": null,\r\n \"summary\": null\r\n },\r\n \"extended\": \"\",\r\n \"meta\": \"\",\r\n \"origin\": \"\",\r\n \"time\": \"2020-08-30 07:54:49\"\r\n}" }, { "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "key": "Client-Key", "value": "{{clientKey}}", "description": "(Required) Your unique client key." }, { "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}", "description": "(Required) Your unique subscription key." } ], "body": { "mode": "formdata", "formdata": [ { "key": "fileID", "value": "1", "description": "undefined", "type": "text" }, { "key": "webhookUrl", "value": "", "description": "undefined", "type": "text" }, { "key": "file", "value": "{}", "description": "undefined", "type": "text" } ] }, "url": { "raw": "{{baseUrl}}/companies/:companyID/files", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "files" ], "variable": [ { "key": "companyID" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\r\n \"success\": false,\r\n \"data\": [\r\n {\r\n \"code\": 211212,\r\n \"message\": \"File is not valid.\",\r\n \"details\": \"\",\r\n \"element\": \"file\"\r\n }\r\n ],\r\n \"extended\": \"\",\r\n \"meta\": \"\",\r\n \"origin\": \"\",\r\n \"time\": \"2020-08-02 08:13:08\"\r\n}" }, { "name": "Not Found", "originalRequest": { "method": "POST", "header": [ { "key": "Client-Key", "value": "{{clientKey}}", "description": "(Required) Your unique client key." }, { "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}", "description": "(Required) Your unique subscription key." } ], "body": { "mode": "formdata", "formdata": [ { "key": "fileID", "value": "1", "description": "undefined", "type": "text" }, { "key": "webhookUrl", "value": "", "description": "undefined", "type": "text" }, { "key": "file", "value": "{}", "description": "undefined", "type": "text" } ] }, "url": { "raw": "{{baseUrl}}/companies/:companyID/files", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "files" ], "variable": [ { "key": "companyID" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\r\n \"success\": false,\r\n \"data\": [\r\n {\r\n \"code\": 111401,\r\n \"message\": \"Company ID not found.\",\r\n \"details\": \"\",\r\n \"element\": \"companyID\"\r\n }\r\n ],\r\n \"extended\": \"\",\r\n \"meta\": \"\",\r\n \"origin\": \"\",\r\n \"time\": \"2020-07-28 07:40:48\"\r\n}" }, { "name": "Internal Server Error", "originalRequest": { "method": "POST", "header": [ { "key": "Client-Key", "value": "{{clientKey}}", "description": "(Required) Your unique client key." }, { "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}", "description": "(Required) Your unique subscription key." } ], "body": { "mode": "formdata", "formdata": [ { "key": "fileID", "value": "1", "description": "undefined", "type": "text" }, { "key": "webhookUrl", "value": "", "description": "undefined", "type": "text" }, { "key": "file", "value": "{}", "description": "undefined", "type": "text" } ] }, "url": { "raw": "{{baseUrl}}/companies/:companyID/files", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "files" ], "variable": [ { "key": "companyID" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\r\n \"success\": false,\r\n \"data\": [\r\n {\r\n \"code\": 1009220,\r\n \"message\": \"Database operation failed.\",\r\n \"details\": \"\",\r\n \"element\": \"\"\r\n }\r\n ],\r\n \"extended\": \"\",\r\n \"meta\": \"\",\r\n \"origin\": \"\",\r\n \"time\": \"2020-07-28 07:45:27\"\r\n}" } ] }, { "name": "Retrieve a file", "request": { "method": "GET", "header": [ { "key": "Client-Key", "value": "{{clientKey}}", "description": "(Required) Your unique client key." }, { "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}", "description": "(Required) Your unique subscription key." } ], "url": { "raw": "{{baseUrl}}/companies/:companyID/files/:fileID", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "files", ":fileID" ], "query": [ { "key": "conformity", "value": "true", "description": "When set to true, the value of conformity calculated will be returned in the conformity object", "disabled": true }, { "key": "conformityFilters", "value": "supplier, accounts", "description": "A comma-separated list of specific fields to filter conformity against. Can be used in conjunction with conformity to assess conformity on particular dimensions such as supplier, description, accounts, etc.", "disabled": true }, { "key": "summary", "value": "true", "description": "When set to true, summary of latest events will be provided in the response.", "disabled": true } ], "variable": [ { "key": "companyID", "value": "1", "description": "(Required) The company's unique ID." }, { "key": "fileID", "value": "1", "description": "(Required) The file's unique ID." } ] }, "description": "Retrieve a file." }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Client-Key", "value": "{{clientKey}}", "description": "(Required) Your unique client key." }, { "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}", "description": "(Required) Your unique subscription key." } ], "url": { "raw": "{{baseUrl}}/companies/:companyID/files/:fileID?conformity=true&summary=true", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "files", ":fileID" ], "query": [ { "key": "conformity", "value": "true" }, { "key": "conformityFilters", "value": null, "disabled": true }, { "key": "summary", "value": "true" } ], "variable": [ { "key": "companyID", "value": "1" }, { "key": "fileID", "value": "100" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\r\n \"success\": true,\r\n \"data\": {\r\n \"fileID\": \"100\",\r\n \"fileName\": \"telavox.pdf\",\r\n \"status\": \"WAITING\",\r\n \"type\": \"\",\r\n \"verificationSeries\": \"\",\r\n \"createdDate\": \"2025-06-02 06:01:04\",\r\n \"conformity\": {\r\n \"value\": 71.43\r\n },\r\n \"summary\": {\r\n \"latestExtraction\": {\r\n \"eventDate\": \"2025-06-02 06:03:38\",\r\n \"type\": \"SupplierInvoice\",\r\n \"supplierID\": \"\",\r\n \"ancestor\": \"None\"\r\n },\r\n \"latestBooking\": {\r\n \"eventDate\": \"2025-06-02 06:04:29\",\r\n \"type\": \"SupplierInvoice\",\r\n \"supplierID\": \"f79bf884-be9f-4829-a4ed-b1df0062af68\"\r\n }\r\n }\r\n },\r\n \"extended\": \"\",\r\n \"meta\": \"\",\r\n \"origin\": \"\",\r\n \"time\": \"2020-08-30 07:54:49\"\r\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "key": "Client-Key", "value": "{{clientKey}}", "description": "(Required) Your unique client key." }, { "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}", "description": "(Required) Your unique subscription key." } ], "url": { "raw": "{{baseUrl}}/companies/:companyID/files/:fileID?conformity=true&summary=true", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "files", ":fileID" ], "query": [ { "key": "conformity", "value": "true" }, { "key": "conformityFilters", "value": null, "disabled": true }, { "key": "summary", "value": "true" } ], "variable": [ { "key": "companyID", "value": "1" }, { "key": "fileID", "value": "100" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\r\n \"success\": false,\r\n \"data\": [\r\n {\r\n \"code\": 211402,\r\n \"message\": \"File ID is not valid.\",\r\n \"details\": \"\",\r\n \"element\": \"fileID\"\r\n }\r\n ],\r\n \"extended\": \"\",\r\n \"meta\": \"\",\r\n \"origin\": \"\",\r\n \"time\": \"2020-08-30 08:04:02\"\r\n}" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "key": "Client-Key", "value": "{{clientKey}}", "description": "(Required) Your unique client key." }, { "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}", "description": "(Required) Your unique subscription key." } ], "url": { "raw": "{{baseUrl}}/companies/:companyID/files/:fileID?conformity=true&summary=true", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "files", ":fileID" ], "query": [ { "key": "conformity", "value": "true" }, { "key": "conformityFilters", "value": null, "disabled": true }, { "key": "summary", "value": "true" } ], "variable": [ { "key": "companyID", "value": "1" }, { "key": "fileID", "value": "100" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\r\n \"success\": false,\r\n \"data\": [\r\n {\r\n \"code\": 111401,\r\n \"message\": \"Company ID not found.\",\r\n \"details\": \"\",\r\n \"element\": \"companyID\"\r\n }\r\n ],\r\n \"extended\": \"\",\r\n \"meta\": \"\",\r\n \"origin\": \"\",\r\n \"time\": \"2020-07-28 07:40:48\"\r\n}" }, { "name": "Internal Server Error", "originalRequest": { "method": "GET", "header": [ { "key": "Client-Key", "value": "{{clientKey}}", "description": "(Required) Your unique client key." }, { "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}", "description": "(Required) Your unique subscription key." } ], "url": { "raw": "{{baseUrl}}/companies/:companyID/files/:fileID?conformity=true&summary=true", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "files", ":fileID" ], "query": [ { "key": "conformity", "value": "true" }, { "key": "conformityFilters", "value": null, "disabled": true }, { "key": "summary", "value": "true" } ], "variable": [ { "key": "companyID", "value": "1" }, { "key": "fileID", "value": "100" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\r\n \"success\": false,\r\n \"data\": [\r\n {\r\n \"code\": 1009220,\r\n \"message\": \"Database operation failed.\",\r\n \"details\": \"\",\r\n \"element\": \"\"\r\n }\r\n ],\r\n \"extended\": \"\",\r\n \"meta\": \"\",\r\n \"origin\": \"\",\r\n \"time\": \"2020-07-28 07:45:27\"\r\n}" } ] }, { "name": "Retrieve file details", "request": { "method": "GET", "header": [ { "key": "Client-Key", "value": "{{clientKey}}", "description": "(Required) Your unique client key." }, { "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}", "description": "(Required) Your unique subscription key." } ], "url": { "raw": "{{baseUrl}}/companies/:companyID/files/:fileID/details", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "files", ":fileID", "details" ], "query": [ { "key": "conformity", "value": "true", "description": "When set to true, the value of conformity calculated will be returned in the conformity object", "disabled": true }, { "key": "conformityFilters", "value": "supplier, accounts", "description": "A comma-separated list of specific fields to filter conformity against. Can be used in conjunction with conformity to assess conformity on particular dimensions such as supplier, description, accounts, etc.", "disabled": true }, { "key": "fileContent", "value": "true", "description": "If true, the response will include the Base64-encoded file data, prefixed with `data:;base64,`. Defaults to `false`.", "disabled": true }, { "key": "eventSet", "value": "latestComparison", "description": "Determines which events to return: latestComparison (default) for extraction and booking event used in conformity calculation, or eventHistory for the full list of extractions and bookings", "disabled": true } ], "variable": [ { "key": "companyID", "value": "1", "description": "(Required) The company's unique ID." }, { "key": "fileID", "value": "1", "description": "(Required) The file's unique ID." } ] }, "description": "Retrieve a file." }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Client-Key", "value": "{{clientKey}}", "description": "(Required) Your unique client key." }, { "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}", "description": "(Required) Your unique subscription key." } ], "url": { "raw": "{{baseUrl}}/companies/:companyID/files/:fileID/details?conformity=true&fileContent=true&eventSet=eventHistory", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "files", ":fileID", "details" ], "query": [ { "key": "conformity", "value": "true" }, { "key": "conformityFilters", "value": null, "disabled": true }, { "key": "fileContent", "value": "true" }, { "key": "eventSet", "value": "eventHistory" } ], "variable": [ { "key": "companyID" }, { "key": "fileID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\r\n \"success\": true,\r\n \"data\": {\r\n \"fileID\": \"1\",\r\n \"fileName\": \"file1.pdf.pdf\",\r\n \"status\": \"BOOKED\",\r\n \"type\": \"SupplierInvoice\",\r\n \"effectiveType\": null,\r\n \"verificationSeries\": \"\",\r\n \"conformity\": {\r\n \"value\": 100\r\n },\r\n \"createdDate\": \"2025-06-15 09:07:07\",\r\n \"eventHistory\": [\r\n {\r\n \"eventType\": \"Booking\",\r\n \"type\": \"SupplierInvoice\",\r\n \"eventDate\": \"2025-06-17 08:13:47\",\r\n \"supplierID\": \"1\",\r\n \"description\": \"\",\r\n \"verificationSeries\": \"\",\r\n \"invoiceDate\": \"2025-05-15\",\r\n \"dueDate\": \"2025-05-29\",\r\n \"invoiceNumber\": \"529496\",\r\n \"ocrNumber\": \"52949682\",\r\n \"ourRef\": \"\",\r\n \"yourRef\": \"\",\r\n \"totalSum\": \"6808,00\",\r\n \"vat\": \"\",\r\n \"accounts\": [\r\n {\r\n \"account\": \"4215\",\r\n \"periodicity\": {\r\n \"offsetAccount\": \"\",\r\n \"startDate\": \"\",\r\n \"endDate\": \"\"\r\n },\r\n \"project\": {\r\n \"targetValue\": \"\"\r\n },\r\n \"costBearer\": {\r\n \"targetValue\": \"\"\r\n },\r\n \"resultsCentre\": {\r\n \"targetValue\": \"\"\r\n },\r\n \"debit\": \"6808,00\",\r\n \"credit\": \"\"\r\n }\r\n ]\r\n },\r\n {\r\n \"eventType\": \"Extraction\",\r\n \"type\": \"SupplierInvoice\",\r\n \"eventDate\": \"2025-06-15 08:13:19\",\r\n \"supplierID\": \"1\",\r\n \"description\": \"\",\r\n \"verificationSeries\": \"\",\r\n \"invoiceDate\": \"2025-05-15\",\r\n \"dueDate\": \"2025-05-29\",\r\n \"invoiceNumber\": \"529496\",\r\n \"ocrNumber\": \"52949682\",\r\n \"ourRef\": \"\",\r\n \"yourRef\": \"\",\r\n \"totalSum\": \"6808,00\",\r\n \"vat\": \"\",\r\n \"accounts\": [\r\n {\r\n \"account\": \"4215\",\r\n \"periodicity\": {\r\n \"offsetAccount\": \"\",\r\n \"startDate\": \"\",\r\n \"endDate\": \"\"\r\n },\r\n \"project\": {\r\n \"targetValue\": \"\"\r\n },\r\n \"costBearer\": {\r\n \"targetValue\": \"\"\r\n },\r\n \"resultsCentre\": {\r\n \"targetValue\": \"\"\r\n },\r\n \"debit\": \"6808,00\",\r\n \"credit\": \"\"\r\n }\r\n ]\r\n },\r\n {\r\n \"eventType\": \"Extraction\",\r\n \"type\": \"SupplierInvoice\",\r\n \"eventDate\": \"2025-06-14 09:07:10\",\r\n \"supplierID\": \"1\",\r\n \"description\": \"\",\r\n \"verificationSeries\": \"\",\r\n \"invoiceDate\": \"2025-05-15\",\r\n \"dueDate\": \"2025-05-29\",\r\n \"invoiceNumber\": \"529496\",\r\n \"ocrNumber\": \"52949682\",\r\n \"ourRef\": \"\",\r\n \"yourRef\": \"\",\r\n \"totalSum\": \"6808,00\",\r\n \"vat\": \"\",\r\n \"accounts\": [\r\n {\r\n \"account\": \"4215\",\r\n \"periodicity\": {\r\n \"offsetAccount\": \"\",\r\n \"startDate\": \"\",\r\n \"endDate\": \"\"\r\n },\r\n \"project\": {\r\n \"targetValue\": \"\"\r\n },\r\n \"costBearer\": {\r\n \"targetValue\": \"\"\r\n },\r\n \"resultsCentre\": {\r\n \"targetValue\": \"\"\r\n },\r\n \"debit\": \"6808,00\",\r\n \"credit\": \"\"\r\n }\r\n ]\r\n }\r\n ],\r\n \"fileContent\": \"data:application/pdf;base64,JVBERi0xLjUKJcTl8uXrp/Og0MTGCjEgMCBvYmoKPDwvVHlwZSAvQ2F0YWxvZyAvUGFnZXMgMiAwIFI+PgplbmRvYmoKMiAwIG9iago8PC9UeXBlIC9QYWdlcyAvQ291bnQgMSAvS2lkcyBbMyAwIFJdID4+CmVuZG9iagozIDAgb2JqCjw8L1R5cGUgL1BhZ2UgL1BhcmVudCAyIDAgUiAvTWVkaWFCb3ggWzAgMCA1OTUuMjggODQxLjg1XSA+PgplbmRvYmoKeHJlZgoKMCA0CjAwMDAwMDAwMDAgNjU1MzUgZiAKMDAwMDAwMDAxMCAwMDAwMCBuIAowMDAwMDAwMDY1IDAwMDAwIG4gCjAwMDAwMDAxMTkgMDAwMDAgbiAKMDAwMDAwMDIxNSAwMDAwMCBuIAp0cmFpbGVyCjw8L1NpemUgNCAvUm9vdCAxIDAgUiAvSW5mbyA4IDAgUiAvSUQgWyAzNDQwYWQ0ODQyYWRkZTNkYjMzOGQ3YjE5NTE5MzQ2XSAvUHJldmlldyA3IDAgUiA+PgpzdGFydHhyZWYKNDE1CiUlRU9G==\",\r\n \"fileText\": {\r\n \"rawText\": \"Lorem ipsum dolor sit amet consectetur adipiscing elit. Quisque faucibus ex sapien vitae pellentesque sem placerat. In id cursus mi pretium tellus duis convallis. Tempus leo eu aenean sed diam urna tempor. Pulvinar vivamus fringilla lacus nec metus bibendum egestas. Iaculis massa nisl malesuada lacinia integer nunc posuere. Ut hendrerit semper vel class aptent taciti sociosqu. Ad litora torquent per conubia nostra inceptos himenaeos.\"\r\n }\r\n },\r\n \"extended\": \"\",\r\n \"meta\": \"\",\r\n \"origin\": \"\",\r\n \"time\": \"2025-06-23 16:13:29\"\r\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "key": "Client-Key", "value": "{{clientKey}}", "description": "(Required) Your unique client key." }, { "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}", "description": "(Required) Your unique subscription key." } ], "url": { "raw": "{{baseUrl}}/companies/:companyID/files/:fileID/details?conformity=true&fileContent=true&eventSet=eventHistory", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "files", ":fileID", "details" ], "query": [ { "key": "conformity", "value": "true" }, { "key": "conformityFilters", "value": null, "disabled": true }, { "key": "fileContent", "value": "true" }, { "key": "eventSet", "value": "eventHistory" } ], "variable": [ { "key": "companyID" }, { "key": "fileID" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\r\n \"success\": false,\r\n \"data\": [\r\n {\r\n \"code\": 211402,\r\n \"message\": \"File ID is not valid.\",\r\n \"details\": \"\",\r\n \"element\": \"fileID\"\r\n }\r\n ],\r\n \"extended\": \"\",\r\n \"meta\": \"\",\r\n \"origin\": \"\",\r\n \"time\": \"2020-08-30 08:04:02\"\r\n}" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "key": "Client-Key", "value": "{{clientKey}}", "description": "(Required) Your unique client key." }, { "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}", "description": "(Required) Your unique subscription key." } ], "url": { "raw": "{{baseUrl}}/companies/:companyID/files/:fileID/details?conformity=true&fileContent=true&eventSet=eventHistory", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "files", ":fileID", "details" ], "query": [ { "key": "conformity", "value": "true" }, { "key": "conformityFilters", "value": null, "disabled": true }, { "key": "fileContent", "value": "true" }, { "key": "eventSet", "value": "eventHistory" } ], "variable": [ { "key": "companyID" }, { "key": "fileID" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\r\n \"success\": false,\r\n \"data\": [\r\n {\r\n \"code\": 111401,\r\n \"message\": \"Company ID not found.\",\r\n \"details\": \"\",\r\n \"element\": \"companyID\"\r\n }\r\n ],\r\n \"extended\": \"\",\r\n \"meta\": \"\",\r\n \"origin\": \"\",\r\n \"time\": \"2020-07-28 07:40:48\"\r\n}" }, { "name": "Internal Server Error", "originalRequest": { "method": "GET", "header": [ { "key": "Client-Key", "value": "{{clientKey}}", "description": "(Required) Your unique client key." }, { "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}", "description": "(Required) Your unique subscription key." } ], "url": { "raw": "{{baseUrl}}/companies/:companyID/files/:fileID/details?conformity=true&fileContent=true&eventSet=eventHistory", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "files", ":fileID", "details" ], "query": [ { "key": "conformity", "value": "true" }, { "key": "conformityFilters", "value": null, "disabled": true }, { "key": "fileContent", "value": "true" }, { "key": "eventSet", "value": "eventHistory" } ], "variable": [ { "key": "companyID" }, { "key": "fileID" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\r\n \"success\": false,\r\n \"data\": [\r\n {\r\n \"code\": 1009220,\r\n \"message\": \"Database operation failed.\",\r\n \"details\": \"\",\r\n \"element\": \"\"\r\n }\r\n ],\r\n \"extended\": \"\",\r\n \"meta\": \"\",\r\n \"origin\": \"\",\r\n \"time\": \"2020-07-28 07:45:27\"\r\n}" } ] }, { "name": "Retrieve all files", "request": { "method": "GET", "header": [ { "key": "Client-Key", "value": "{{clientKey}}", "description": "(Required) Your unique client key." }, { "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}", "description": "(Required) Your unique subscription key." }, { "key": "Content-Type", "value": "multipart/form-data" } ], "url": { "raw": "{{baseUrl}}/companies/:companyID/files", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "files" ], "query": [ { "key": "text", "value": null, "description": "A keyword or combination of keywords to search within the file content. Useful for full-text search across file records.", "disabled": true }, { "key": "fileCreatedFrom", "value": "2025-05-01 00:00:00", "description": "The start date and time (inclusive) for filtering files based on their creation date. Format: YYYY-MM-DD HH:mm:ss.", "disabled": true }, { "key": "fileCreatedTo", "value": "2025-06-01 00:00:00", "description": "The end date and time (inclusive) for filtering files based on their creation date. Format: YYYY-MM-DD HH:mm:ss", "disabled": true }, { "key": "type", "value": "SupplierInvoice", "description": "Filter by the type of file. Allowed value: 'SupplierInvoice', or 'Receipt'", "disabled": true }, { "key": "status", "value": "Complete", "description": "Filter by the processing state of the file. Allowed value: 'Ready', 'Extracted', 'Booked', 'Complete' or 'Error'.", "disabled": true }, { "key": "summary", "value": "true", "description": "When set to true, summary data will be provided in the response.", "disabled": true }, { "key": "conformity", "value": "true", "description": "When set to true, conformity data will be provided in the response.", "disabled": true }, { "key": "conformityFilters", "value": null, "description": "A comma-separated list of specific fields to calculate conformity on. Can be used in conjunction with conformity to assess performance on particular dimension such as supplier, description, accounts, etc.", "disabled": true }, { "key": "pageNumber", "value": "1", "description": "The page number of the result set to retrieve. Starts at 1.", "disabled": true }, { "key": "pageSize", "value": "20", "description": "Specifies how many items to return on each page of results. Default 10, Max 100", "disabled": true }, { "key": "sortField", "value": "FileName", "description": "The field to sort the result set. Allowed values: 'CreatedDateUTC' (default), 'FileName', 'Status'.", "disabled": true }, { "key": "sortDirection", "value": "asc", "description": "The order in which results are sorted. Accepted values: 'asc' for ascending, 'desc' for descending. Defaults to descending if not specified.", "disabled": true } ], "variable": [ { "key": "companyID", "value": "1", "description": "(Required) The company's unique ID." } ] }, "description": "Add a file." }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Client-Key", "value": "{{clientKey}}", "description": "(Required) Your unique client key." }, { "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}", "description": "(Required) Your unique subscription key." } ], "url": { "raw": "{{baseUrl}}/companies/:companyID/files?conformity=true&pageNumber=1&pageSize=3", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "files" ], "query": [ { "key": "text", "value": null, "disabled": true }, { "key": "fileCreatedFrom", "value": null, "disabled": true }, { "key": "fileCreatedTo", "value": null, "disabled": true }, { "key": "type", "value": null, "disabled": true }, { "key": "status", "value": null, "disabled": true }, { "key": "summary", "value": "true", "disabled": true }, { "key": "conformity", "value": "true" }, { "key": "conformityFilters", "value": null, "disabled": true }, { "key": "pageNumber", "value": "1" }, { "key": "pageSize", "value": "3" }, { "key": "sortDirection", "value": null, "disabled": true }, { "key": "sortField", "value": null, "disabled": true } ], "variable": [ { "key": "companyID", "value": "1" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\r\n \"success\": true,\r\n \"data\": [\r\n {\r\n \"fileID\": \"1\",\r\n \"fileName\": \"file1.pdf\",\r\n \"status\": \"COMPLETE\",\r\n \"type\": \"SupplierInvoice\",\r\n \"verificationSeries\": \"\",\r\n \"conformity\": {\r\n \"value\": 100\r\n },\r\n \"createdDate\": \"2025-06-01 12:45:53\",\r\n \"summary\": {\r\n \"latestExtraction\": {\r\n \"eventDate\": \"2026-06-02 13:55:03\",\r\n \"type\": \"SupplierInvoice\",\r\n \"supplierID\": \"1\",\r\n \"ancestor\": \"None\"\r\n },\r\n \"latestBooking\": {\r\n \"eventDate\": \"2026-06-02 13:55:03\",\r\n \"type\": \"SupplierInvoice\",\r\n \"supplierID\": \"1\"\r\n }\r\n }\r\n },\r\n {\r\n \"fileID\": \"2\",\r\n \"fileName\": \"file3.pdf\",\r\n \"status\": \"BOOKED\",\r\n \"type\": \"SupplierInvoice\",\r\n \"verificationSeries\": \"\",\r\n \"conformity\": {\r\n \"value\": null\r\n },\r\n \"createdDate\": \"2025-06-01 12:45:53\",\r\n \"summary\": {\r\n \"latestExtraction\": null,\r\n \"latestBooking\": {\r\n \"eventDate\": \"2026-06-02 13:55:03\",\r\n \"type\": \"SupplierInvoice\",\r\n \"supplierID\": \"2\"\r\n }\r\n }\r\n },\r\n {\r\n \"fileID\": \"3\",\r\n \"fileName\": \"file3.pdf\",\r\n \"status\": \"EXTRACTED\",\r\n \"type\": \"Receipt\",\r\n \"verificationSeries\": \"\",\r\n \"conformity\": {\r\n \"value\": null\r\n },\r\n \"createdDate\": \"2025-06-02 12:22:37\",\r\n \"summary\": {\r\n \"latestExtraction\": {\r\n \"eventDate\": \"2025-06-02 12:25:25\",\r\n \"type\": \"Receipt\",\r\n \"supplierID\": null,\r\n \"ancestor\": \"StartBot\"\r\n },\r\n \"latestBooking\": null\r\n }\r\n },\r\n {\r\n \"fileID\": \"4\",\r\n \"fileName\": \"file4.pdf\",\r\n \"status\": \"ERROR\",\r\n \"type\": \"Other\",\r\n \"verificationSeries\": \"\",\r\n \"conformity\": {\r\n \"value\": null\r\n },\r\n \"createdDate\": \"2025-06-03 06:13:33\",\r\n \"summary\": {\r\n \"latestExtraction\": null,\r\n \"latestBooking\": null\r\n }\r\n },\r\n {\r\n \"fileID\": \"5\",\r\n \"fileName\": \"file5.pdf\",\r\n \"status\": \"READY\",\r\n \"type\": \"Other\",\r\n \"verificationSeries\": \"\",\r\n \"conformity\": {\r\n \"value\": null\r\n },\r\n \"createdDate\": \"2024-08-05 08:08:03\",\r\n \"summary\": {\r\n \"latestExtraction\": null,\r\n \"latestBooking\": null\r\n }\r\n }\r\n ],\r\n \"extended\": \"\",\r\n \"meta\": {\r\n \"pagination\": {\r\n \"pageNumber\": 1,\r\n \"pageSize\": 5,\r\n \"totalItems\": 50,\r\n \"totalPages\": 10\r\n },\r\n \"aggregates\": {\r\n \"averageConformity\": 100\r\n },\r\n \"updated\": \"2026-08-05 07:00:00\"\r\n },\r\n \"origin\": \"\",\r\n \"time\": \"2020-08-30 07:54:49\"\r\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "key": "Client-Key", "value": "{{clientKey}}", "description": "(Required) Your unique client key." }, { "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}", "description": "(Required) Your unique subscription key." } ], "url": { "raw": "{{baseUrl}}/companies/:companyID/files?conformity=true&pageNumber=1&pageSize=3", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "files" ], "query": [ { "key": "text", "value": null, "disabled": true }, { "key": "fileCreatedFrom", "value": null, "disabled": true }, { "key": "fileCreatedTo", "value": null, "disabled": true }, { "key": "type", "value": null, "disabled": true }, { "key": "status", "value": null, "disabled": true }, { "key": "summary", "value": "true", "disabled": true }, { "key": "conformity", "value": "true" }, { "key": "conformityFilters", "value": null, "disabled": true }, { "key": "pageNumber", "value": "1" }, { "key": "pageSize", "value": "3" }, { "key": "sortDirection", "value": null, "disabled": true }, { "key": "sortField", "value": null, "disabled": true } ], "variable": [ { "key": "companyID", "value": "1" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\r\n \"success\": false,\r\n \"data\": [\r\n {\r\n \"code\": 101152,\r\n \"message\": \"Query parameter is not valid.\",\r\n \"details\": \"Unsupported type. Please choose one of: SupplierInvoice, Receipt or Other.\",\r\n \"element\": \"type\"\r\n }\r\n ],\r\n \"extended\": \"\",\r\n \"meta\": \"\",\r\n \"origin\": \"\",\r\n \"time\": \"2020-08-02 08:13:08\"\r\n}" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "key": "Client-Key", "value": "{{clientKey}}", "description": "(Required) Your unique client key." }, { "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}", "description": "(Required) Your unique subscription key." } ], "url": { "raw": "{{baseUrl}}/companies/:companyID/files?conformity=true&pageNumber=1&pageSize=3", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "files" ], "query": [ { "key": "text", "value": null, "disabled": true }, { "key": "fileCreatedFrom", "value": null, "disabled": true }, { "key": "fileCreatedTo", "value": null, "disabled": true }, { "key": "type", "value": null, "disabled": true }, { "key": "status", "value": null, "disabled": true }, { "key": "summary", "value": "true", "disabled": true }, { "key": "conformity", "value": "true" }, { "key": "conformityFilters", "value": null, "disabled": true }, { "key": "pageNumber", "value": "1" }, { "key": "pageSize", "value": "3" }, { "key": "sortDirection", "value": null, "disabled": true }, { "key": "sortField", "value": null, "disabled": true } ], "variable": [ { "key": "companyID", "value": "1" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\r\n \"success\": false,\r\n \"data\": [\r\n {\r\n \"code\": 111401,\r\n \"message\": \"Company ID not found.\",\r\n \"details\": \"\",\r\n \"element\": \"companyID\"\r\n }\r\n ],\r\n \"extended\": \"\",\r\n \"meta\": \"\",\r\n \"origin\": \"\",\r\n \"time\": \"2020-07-28 07:40:48\"\r\n}" }, { "name": "Internal Server Error", "originalRequest": { "method": "GET", "header": [ { "key": "Client-Key", "value": "{{clientKey}}", "description": "(Required) Your unique client key." }, { "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}", "description": "(Required) Your unique subscription key." } ], "url": { "raw": "{{baseUrl}}/companies/:companyID/files?conformity=true&pageNumber=1&pageSize=3", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "files" ], "query": [ { "key": "text", "value": null, "disabled": true }, { "key": "fileCreatedFrom", "value": null, "disabled": true }, { "key": "fileCreatedTo", "value": null, "disabled": true }, { "key": "type", "value": null, "disabled": true }, { "key": "status", "value": null, "disabled": true }, { "key": "summary", "value": "true", "disabled": true }, { "key": "conformity", "value": "true" }, { "key": "conformityFilters", "value": null, "disabled": true }, { "key": "pageNumber", "value": "1" }, { "key": "pageSize", "value": "3" }, { "key": "sortDirection", "value": null, "disabled": true }, { "key": "sortField", "value": null, "disabled": true } ], "variable": [ { "key": "companyID", "value": "1" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\r\n \"success\": false,\r\n \"data\": [\r\n {\r\n \"code\": 1009220,\r\n \"message\": \"Database operation failed.\",\r\n \"details\": \"\",\r\n \"element\": \"\"\r\n }\r\n ],\r\n \"extended\": \"\",\r\n \"meta\": \"\",\r\n \"origin\": \"\",\r\n \"time\": \"2020-07-28 07:45:27\"\r\n}" } ] }, { "name": "Update a file", "request": { "method": "PATCH", "header": [ { "key": "Client-Key", "value": "{{clientKey}}", "description": "(Required) Your unique client key." }, { "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}", "description": "(Required) Your unique subscription key." }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\r\n \"type\": \"Receipt\",\r\n \"verificationSeries\": \"A\"\r\n}" }, "url": { "raw": "{{baseUrl}}/companies/:companyID/files/:fileID", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "files", ":fileID" ], "variable": [ { "key": "companyID", "value": "1", "description": "(Required) The company's unique ID." }, { "key": "fileID", "value": "1", "description": "(Required) The supplier's unique ID." } ] }, "description": "Update a file." }, "response": [ { "name": "OK", "originalRequest": { "method": "PATCH", "header": [ { "key": "Client-Key", "value": "{{clientKey}}", "description": "(Required) Your unique client key." }, { "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}", "description": "(Required) Your unique subscription key." }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"type\": \"Receipt\",\n \"verificationSeries\": \"A\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/companies/:companyID/files/:fileID", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "files", ":fileID" ], "variable": [ { "key": "companyID" }, { "key": "fileID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\r\n \"success\": true,\r\n \"data\": {\r\n \"fileID\": \"100\",\r\n \"fileName\": \"telavox.pdf\",\r\n \"status\": \"READY\",\r\n \"type\": \"Receipt\",\r\n \"verificationSeries\": \"A\",\r\n \"createdDate\": \"2025-06-02 06:01:04\",\r\n \"conformity\": null,\r\n \"summary\": null\r\n },\r\n \"extended\": \"\",\r\n \"meta\": \"\",\r\n \"origin\": \"\",\r\n \"time\": \"2020-08-30 07:54:49\"\r\n}" }, { "name": "Bad Request", "originalRequest": { "method": "PATCH", "header": [ { "key": "Client-Key", "value": "{{clientKey}}", "description": "(Required) Your unique client key." }, { "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}", "description": "(Required) Your unique subscription key." }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"type\": \"Receipt\",\n \"verificationSeries\": \"A\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/companies/:companyID/files/:fileID", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "files", ":fileID" ], "variable": [ { "key": "companyID" }, { "key": "fileID" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\r\n \"success\": false,\r\n \"data\": [\r\n {\r\n \"code\": 211101,\r\n \"message\": \"All parameters are missing.\",\r\n \"details\": \"At least destination Type or destination Series must be given.\",\r\n \"element\": \"\"\r\n }\r\n ],\r\n \"extended\": \"\",\r\n \"meta\": \"\",\r\n \"origin\": \"\",\r\n \"time\": \"2020-05-29 08:35:17\"\r\n}" }, { "name": "Not Found", "originalRequest": { "method": "PATCH", "header": [ { "key": "Client-Key", "value": "{{clientKey}}", "description": "(Required) Your unique client key." }, { "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}", "description": "(Required) Your unique subscription key." }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"type\": \"Receipt\",\n \"verificationSeries\": \"A\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/companies/:companyID/files/:fileID", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "files", ":fileID" ], "variable": [ { "key": "companyID" }, { "key": "fileID" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\r\n \"success\": false,\r\n \"data\": [\r\n {\r\n \"code\": 111401,\r\n \"message\": \"Company ID not found.\",\r\n \"details\": \"\",\r\n \"element\": \"companyID\"\r\n }\r\n ],\r\n \"extended\": \"\",\r\n \"meta\": \"\",\r\n \"origin\": \"\",\r\n \"time\": \"2020-07-28 07:40:48\"\r\n}" }, { "name": "Precondition Failed", "originalRequest": { "method": "PATCH", "header": [ { "key": "Client-Key", "value": "{{clientKey}}", "description": "(Required) Your unique client key." }, { "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}", "description": "(Required) Your unique subscription key." }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"type\": \"Receipt\",\n \"verificationSeries\": \"A\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/companies/:companyID/files/:fileID", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "files", ":fileID" ], "variable": [ { "key": "companyID" }, { "key": "fileID" } ] } }, "status": "Precondition Failed", "code": 412, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\r\n \"success\": false,\r\n \"data\": [\r\n {\r\n \"code\": 211215,\r\n \"message\": \"File is not ready for extraction.\",\r\n \"details\": \"\",\r\n \"element\": \"file\"\r\n }\r\n ],\r\n \"extended\": \"\",\r\n \"meta\": \"\",\r\n \"origin\": \"\",\r\n \"time\": \"2020-05-29 08:35:17\"\r\n}" }, { "name": "Internal Server Error", "originalRequest": { "method": "PATCH", "header": [ { "key": "Client-Key", "value": "{{clientKey}}", "description": "(Required) Your unique client key." }, { "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}", "description": "(Required) Your unique subscription key." }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"type\": \"Receipt\",\n \"verificationSeries\": \"A\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/companies/:companyID/files/:fileID", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "files", ":fileID" ], "variable": [ { "key": "companyID" }, { "key": "fileID" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\r\n \"success\": false,\r\n \"data\": [\r\n {\r\n \"code\": 1009220,\r\n \"message\": \"Database operation failed.\",\r\n \"details\": \"\",\r\n \"element\": \"\"\r\n }\r\n ],\r\n \"extended\": \"\",\r\n \"meta\": \"\",\r\n \"origin\": \"\",\r\n \"time\": \"2020-07-28 07:45:27\"\r\n}" } ] } ] }, { "name": "Suppliers", "item": [ { "name": "Add a supplier", "request": { "method": "POST", "header": [ { "key": "Client-Key", "value": "{{clientKey}}", "description": "(Required) Your unique client key." }, { "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}", "description": "(Required) Your unique subscription key." }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\r\n \"supplierID\": \"1\",\r\n \"supplierName\": \"Telavox\",\r\n \"corporateIdentityNumber\": \"556600-7786\",\r\n \"bankAccountNumber\": \"5677-6487\",\r\n \"plusGiroNumber\": \"\",\r\n \"iban\": \"SE1150000000056241002716\",\r\n \"vatNumber\": \"SE556600778601\",\r\n \"countryOfOrigin\": \"SE\",\r\n \"supplierTags\": {\r\n \"supplierTag1\": \"+46712345678\",\r\n \"supplierTag2\": \"example@email.com\",\r\n \"supplierTag3\": \"\",\r\n \"supplierTag4\": \"\",\r\n \"supplierTag5\": \"\",\r\n \"supplierTag6\": \"\"\r\n }\r\n}" }, "url": { "raw": "{{baseUrl}}/companies/:companyID/suppliers", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "suppliers" ], "variable": [ { "key": "companyID", "value": "1", "description": "(Required) The company's unique ID." } ] }, "description": "Add a supplier." }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "key": "Client-Key", "value": "{{clientKey}}", "description": "(Required) Your unique client key." }, { "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}", "description": "(Required) Your unique subscription key." }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"supplierID\": \"1\",\n \"supplierName\": \"Telavox\",\n \"corporateIdentityNumber\": \"556600-7786\",\n \"bankAccountNumber\": \"5677-6487\",\n \"plusGiroNumber\": \"\",\n \"iban\": \"SE1150000000056241002716\",\n \"vatNumber\": \"SE556600778601\",\n \"countryOfOrigin\": \"SE\",\n \"supplierTags\": {\n \"supplierTag1\": \"\",\n \"supplierTag2\": \"\",\n \"supplierTag3\": \"\",\n \"supplierTag4\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/companies/:companyID/suppliers", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "suppliers" ], "variable": [ { "key": "companyID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\r\n \"success\": true,\r\n \"data\": {\r\n \"supplierID\": \"1\",\r\n \"supplierName\": \"Telavox\",\r\n \"corporateIdentityNumber\": \"556600-7786\",\r\n \"bankAccountNumber\": \"5677-6487\",\r\n \"plusGiroNumber\": \"\",\r\n \"iban\": \"SE1150000000056241002716\",\r\n \"vatNumber\": \"SE556600778601\",\r\n \"countryOfOrigin\": \"SE\",\r\n \"supplierTags\": {\r\n \"supplierTag1\": \"+46712345678\",\r\n \"supplierTag2\": \"example@email.com\",\r\n \"supplierTag3\": \"\",\r\n \"supplierTag4\": \"\",\r\n \"supplierTag5\": \"\",\r\n \"supplierTag6\": \"\"\r\n }\r\n },\r\n \"extended\": \"\",\r\n \"meta\": \"\",\r\n \"origin\": \"\",\r\n \"time\": \"2020-03-28 11:41:02\"\r\n}" }, { "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "key": "Client-Key", "value": "{{clientKey}}", "description": "(Required) Your unique client key." }, { "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}", "description": "(Required) Your unique subscription key." }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"supplierID\": \"1\",\n \"supplierName\": \"Telavox\",\n \"corporateIdentityNumber\": \"556600-7786\",\n \"bankAccountNumber\": \"5677-6487\",\n \"plusGiroNumber\": \"\",\n \"iban\": \"SE1150000000056241002716\",\n \"vatNumber\": \"SE556600778601\",\n \"countryOfOrigin\": \"SE\",\n \"supplierTags\": {\n \"supplierTag1\": \"\",\n \"supplierTag2\": \"\",\n \"supplierTag3\": \"\",\n \"supplierTag4\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/companies/:companyID/suppliers", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "suppliers" ], "variable": [ { "key": "companyID" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\r\n \"success\": false,\r\n \"data\": [\r\n {\r\n \"code\": 611101,\r\n \"message\": \"All supplier specific parameters are either missing or invalid.\",\r\n \"details\": \"\",\r\n \"element\": \"\"\r\n }\r\n ],\r\n \"extended\": \"\",\r\n \"meta\": \"\",\r\n \"origin\": \"\",\r\n \"time\": \"2020-08-02 09:28:35\"\r\n}" }, { "name": "Not Found", "originalRequest": { "method": "POST", "header": [ { "key": "Client-Key", "value": "{{clientKey}}", "description": "(Required) Your unique client key." }, { "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}", "description": "(Required) Your unique subscription key." }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"supplierID\": \"1\",\n \"supplierName\": \"Telavox\",\n \"corporateIdentityNumber\": \"556600-7786\",\n \"bankAccountNumber\": \"5677-6487\",\n \"plusGiroNumber\": \"\",\n \"iban\": \"SE1150000000056241002716\",\n \"vatNumber\": \"SE556600778601\",\n \"countryOfOrigin\": \"SE\",\n \"supplierTags\": {\n \"supplierTag1\": \"\",\n \"supplierTag2\": \"\",\n \"supplierTag3\": \"\",\n \"supplierTag4\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/companies/:companyID/suppliers", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "suppliers" ], "variable": [ { "key": "companyID" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\r\n \"success\": false,\r\n \"data\": [\r\n {\r\n \"code\": 111401,\r\n \"message\": \"Company ID not found.\",\r\n \"details\": \"\",\r\n \"element\": \"companyID\"\r\n }\r\n ],\r\n \"extended\": \"\",\r\n \"meta\": \"\",\r\n \"origin\": \"\",\r\n \"time\": \"2020-07-28 07:40:48\"\r\n}" }, { "name": "Internal Server Error", "originalRequest": { "method": "POST", "header": [ { "key": "Client-Key", "value": "{{clientKey}}", "description": "(Required) Your unique client key." }, { "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}", "description": "(Required) Your unique subscription key." }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"supplierID\": \"1\",\n \"supplierName\": \"Telavox\",\n \"corporateIdentityNumber\": \"556600-7786\",\n \"bankAccountNumber\": \"5677-6487\",\n \"plusGiroNumber\": \"\",\n \"iban\": \"SE1150000000056241002716\",\n \"vatNumber\": \"SE556600778601\",\n \"countryOfOrigin\": \"SE\",\n \"supplierTags\": {\n \"supplierTag1\": \"\",\n \"supplierTag2\": \"\",\n \"supplierTag3\": \"\",\n \"supplierTag4\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/companies/:companyID/suppliers", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "suppliers" ], "variable": [ { "key": "companyID" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\r\n \"success\": false,\r\n \"data\": [\r\n {\r\n \"code\": 1009220,\r\n \"message\": \"Database operation failed.\",\r\n \"details\": \"\",\r\n \"element\": \"\"\r\n }\r\n ],\r\n \"extended\": \"\",\r\n \"meta\": \"\",\r\n \"origin\": \"\",\r\n \"time\": \"2020-07-28 07:45:27\"\r\n}" } ] }, { "name": "Add a supplier list", "request": { "method": "POST", "header": [ { "key": "Client-Key", "value": "{{clientKey}}", "description": "(Required) Your unique client key." }, { "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}", "description": "(Required) Your unique subscription key." }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\r\n \"suppliers\": [\r\n {\r\n \"supplierID\": \"1\",\r\n \"supplierName\": \"Telavox\",\r\n \"corporateIdentityNumber\": \"556600-7786\",\r\n \"bankAccountNumber\": \"5677-6487\",\r\n \"plusGiroNumber\": \"\",\r\n \"iban\": \"SE1150000000056241002716\",\r\n \"vatNumber\": \"SE556600778601\",\r\n \"countryOfOrigin\": \"SE\",\r\n \"supplierTags\": {\r\n \"supplierTag1\": \"+46712345678\",\r\n \"supplierTag2\": \"example@email.com\",\r\n \"supplierTag3\": \"\",\r\n \"supplierTag4\": \"\",\r\n \"supplierTag5\": \"\",\r\n \"supplierTag6\": \"\"\r\n }\r\n },\r\n {\r\n \"supplierID\": \"2\",\r\n \"supplierName\": \"Telenor\",\r\n \"corporateIdentityNumber\": \"556421-0309\",\r\n \"bankAccountNumber\": \"5331-1338\",\r\n \"plusGiroNumber\": \"4792603-5\",\r\n \"iban\": \"SE2195000099603447926035\",\r\n \"vatNumber\": \"SE556421030901\",\r\n \"countryOfOrigin\": \"\"\r\n },\r\n {\r\n \"supplierID\": \"3\",\r\n \"supplierName\": \"Dutch Supplier B.V.\",\r\n \"corporateIdentityNumber\": \"12345678\",\r\n \"bankAccountNumber\": \"\",\r\n \"plusGiroNumber\": \"\",\r\n \"iban\": \"NL91ABNA0417164300\",\r\n \"vatNumber\": \"NL987654321B01\",\r\n \"countryOfOrigin\": \"NL\",\r\n \"supplierTags\": {\r\n \"supplierTag1\": \"+31207654321\",\r\n \"supplierTag2\": \"contact@dutchsupplier.nl\",\r\n \"supplierTag3\": \"\",\r\n \"supplierTag4\": \"\",\r\n \"supplierTag5\": \"\",\r\n \"supplierTag6\": \"\"\r\n }\r\n }\r\n ]\r\n}" }, "url": { "raw": "{{baseUrl}}/companies/:companyID/suppliers/multiple", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "suppliers", "multiple" ], "variable": [ { "key": "companyID", "value": "1", "description": "(Required) The company's unique ID." } ] }, "description": "Add a supplier list." }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "key": "Client-Key", "value": "{{clientKey}}", "description": "(Required) Your unique client key." }, { "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}", "description": "(Required) Your unique subscription key." }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"suppliers\": [\n {\n \"supplierID\": \"1\",\n \"supplierName\": \"Telavox\",\n \"corporateIdentityNumber\": \"556600-7786\",\n \"bankAccountNumber\": \"5677-6487\",\n \"plusGiroNumber\": \"\",\n \"iban\": \"SE1150000000056241002716\",\n \"vatNumber\": \"SE556600778601\",\n \"countryOfOrigin\": \"SE\",\n \"supplierTags\": {\n \"supplierTag1\": \"07XXXXXXXX\",\n \"supplierTag2\": \"\",\n \"supplierTag3\": \"\",\n \"supplierTag4\": \"\"\n }\n },\n {\n \"supplierID\": \"2\",\n \"supplierName\": \"Telenor\",\n \"corporateIdentityNumber\": \"556421-0309\",\n \"bankAccountNumber\": \"5331-1338\",\n \"plusGiroNumber\": \"4792603-5\",\n \"iban\": \"SE2195000099603447926035\",\n \"vatNumber\": \"SE556421030901\",\n \"countryOfOrigin\": \"\"\n },\n {\n \"supplierID\": \"3\",\n \"supplierName\": \"Dutch Supplier B.V.\",\n \"corporateIdentityNumber\": \"12345678\",\n \"bankAccountNumber\": \"\",\n \"plusGiroNumber\": \"\",\n \"iban\": \"NL91ABNA0417164300\",\n \"vatNumber\": \"NL987654321B01\",\n \"countryOfOrigin\": \"NL\",\n \"supplierTags\": {\n \"supplierTag1\": \"+31207654321\",\n \"supplierTag2\": \"contact@dutchsupplier.nl\",\n \"supplierTag3\": \"\",\n \"supplierTag4\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/companies/:companyID/suppliers/multiple", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "suppliers", "multiple" ], "variable": [ { "key": "companyID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\r\n \"objectList\": [\r\n {\r\n \"success\": true,\r\n \"data\": {\r\n \"supplierID\": \"1\",\r\n \"supplierName\": \"Telavox\",\r\n \"corporateIdentityNumber\": \"556600-7786\",\r\n \"bankAccountNumber\": \"5677-6487\",\r\n \"plusGiroNumber\": \"SE1150000000056241002716\",\r\n \"iban\": \"\",\r\n \"vatNumber\": \"SE556600778601\",\r\n \"countryOfOrigin\": \"SE\",\r\n \"supplierTags\": {\r\n \"supplierTag1\": \"+46712345678\",\r\n \"supplierTag2\": \"example@email.com\",\r\n \"supplierTag3\": \"\",\r\n \"supplierTag4\": \"\",\r\n \"supplierTag5\": \"\",\r\n \"supplierTag6\": \"\"\r\n }\r\n },\r\n \"objectID\": \"1\"\r\n },\r\n {\r\n \"success\": true,\r\n \"data\": {\r\n \"supplierID\": \"2\",\r\n \"supplierName\": \"Telenor\",\r\n \"corporateIdentityNumber\": \"556421-0309\",\r\n \"bankAccountNumber\": \"5331-1338\",\r\n \"plusGiroNumber\": \"4792603-5\",\r\n \"iban\": \"SE2195000099603447926035\",\r\n \"vatNumber\": \"SE556421030901\",\r\n \"countryOfOrigin\": \"\"\r\n },\r\n \"objectID\": \"2\"\r\n },\r\n {\r\n \"success\": true,\r\n \"data\": {\r\n \"supplierID\": \"3\",\r\n \"supplierName\": \"Dutch Supplier B.V.\",\r\n \"corporateIdentityNumber\": \"12345678\",\r\n \"bankAccountNumber\": \"\",\r\n \"plusGiroNumber\": \"\",\r\n \"iban\": \"NL91ABNA0417164300\",\r\n \"vatNumber\": \"NL987654321B01\",\r\n \"countryOfOrigin\": \"NL\",\r\n \"supplierTags\": {\r\n \"supplierTag1\": \"+31207654321\",\r\n \"supplierTag2\": \"contact@dutchsupplier.nl\",\r\n \"supplierTag3\": \"\",\r\n \"supplierTag4\": \"\",\r\n \"supplierTag5\": \"\",\r\n \"supplierTag6\": \"\"\r\n },\r\n \"objectID\": \"3\"\r\n }\r\n }\r\n ],\r\n \"time\": \"2020-03-28 11:41:02\"\r\n}" }, { "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "key": "Client-Key", "value": "{{clientKey}}", "description": "(Required) Your unique client key." }, { "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}", "description": "(Required) Your unique subscription key." }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"suppliers\": [\n {\n \"supplierID\": \"1\",\n \"supplierName\": \"Telavox\",\n \"corporateIdentityNumber\": \"556600-7786\",\n \"bankAccountNumber\": \"5677-6487\",\n \"plusGiroNumber\": \"\",\n \"iban\": \"SE1150000000056241002716\",\n \"vatNumber\": \"SE556600778601\",\n \"countryOfOrigin\": \"SE\",\n \"supplierTags\": {\n \"supplierTag1\": \"07XXXXXXXX\",\n \"supplierTag2\": \"\",\n \"supplierTag3\": \"\",\n \"supplierTag4\": \"\"\n }\n },\n {\n \"supplierID\": \"2\",\n \"supplierName\": \"Telenor\",\n \"corporateIdentityNumber\": \"556421-0309\",\n \"bankAccountNumber\": \"5331-1338\",\n \"plusGiroNumber\": \"4792603-5\",\n \"iban\": \"SE2195000099603447926035\",\n \"vatNumber\": \"SE556421030901\",\n \"countryOfOrigin\": \"\"\n },\n {\n \"supplierID\": \"3\",\n \"supplierName\": \"Dutch Supplier B.V.\",\n \"corporateIdentityNumber\": \"12345678\",\n \"bankAccountNumber\": \"\",\n \"plusGiroNumber\": \"\",\n \"iban\": \"NL91ABNA0417164300\",\n \"vatNumber\": \"NL987654321B01\",\n \"countryOfOrigin\": \"NL\",\n \"supplierTags\": {\n \"supplierTag1\": \"+31207654321\",\n \"supplierTag2\": \"contact@dutchsupplier.nl\",\n \"supplierTag3\": \"\",\n \"supplierTag4\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/companies/:companyID/suppliers/multiple", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "suppliers", "multiple" ], "variable": [ { "key": "companyID" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\r\n \"success\": false,\r\n \"data\": [\r\n {\r\n \"code\": 111402,\r\n \"message\": \"Company ID is not valid.\",\r\n \"details\": \"\",\r\n \"element\": \"companyID\"\r\n }\r\n ],\r\n \"extended\": \"\",\r\n \"meta\": \"\",\r\n \"origin\": \"\",\r\n \"time\": \"2020-07-28 07:39:34\"\r\n}" }, { "name": "Not Found", "originalRequest": { "method": "POST", "header": [ { "key": "Client-Key", "value": "{{clientKey}}", "description": "(Required) Your unique client key." }, { "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}", "description": "(Required) Your unique subscription key." }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"suppliers\": [\n {\n \"supplierID\": \"1\",\n \"supplierName\": \"Telavox\",\n \"corporateIdentityNumber\": \"556600-7786\",\n \"bankAccountNumber\": \"5677-6487\",\n \"plusGiroNumber\": \"\",\n \"iban\": \"SE1150000000056241002716\",\n \"vatNumber\": \"SE556600778601\",\n \"countryOfOrigin\": \"SE\",\n \"supplierTags\": {\n \"supplierTag1\": \"07XXXXXXXX\",\n \"supplierTag2\": \"\",\n \"supplierTag3\": \"\",\n \"supplierTag4\": \"\"\n }\n },\n {\n \"supplierID\": \"2\",\n \"supplierName\": \"Telenor\",\n \"corporateIdentityNumber\": \"556421-0309\",\n \"bankAccountNumber\": \"5331-1338\",\n \"plusGiroNumber\": \"4792603-5\",\n \"iban\": \"SE2195000099603447926035\",\n \"vatNumber\": \"SE556421030901\",\n \"countryOfOrigin\": \"\"\n },\n {\n \"supplierID\": \"3\",\n \"supplierName\": \"Dutch Supplier B.V.\",\n \"corporateIdentityNumber\": \"12345678\",\n \"bankAccountNumber\": \"\",\n \"plusGiroNumber\": \"\",\n \"iban\": \"NL91ABNA0417164300\",\n \"vatNumber\": \"NL987654321B01\",\n \"countryOfOrigin\": \"NL\",\n \"supplierTags\": {\n \"supplierTag1\": \"+31207654321\",\n \"supplierTag2\": \"contact@dutchsupplier.nl\",\n \"supplierTag3\": \"\",\n \"supplierTag4\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/companies/:companyID/suppliers/multiple", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "suppliers", "multiple" ], "variable": [ { "key": "companyID" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\r\n \"success\": false,\r\n \"data\": [\r\n {\r\n \"code\": 111401,\r\n \"message\": \"Company ID not found.\",\r\n \"details\": \"\",\r\n \"element\": \"companyID\"\r\n }\r\n ],\r\n \"extended\": \"\",\r\n \"meta\": \"\",\r\n \"origin\": \"\",\r\n \"time\": \"2020-07-28 07:40:48\"\r\n}" }, { "name": "Conflict", "originalRequest": { "method": "POST", "header": [ { "key": "Client-Key", "value": "{{clientKey}}", "description": "(Required) Your unique client key." }, { "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}", "description": "(Required) Your unique subscription key." }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"suppliers\": [\n {\n \"supplierID\": \"1\",\n \"supplierName\": \"Telavox\",\n \"corporateIdentityNumber\": \"556600-7786\",\n \"bankAccountNumber\": \"5677-6487\",\n \"plusGiroNumber\": \"\",\n \"iban\": \"SE1150000000056241002716\",\n \"vatNumber\": \"SE556600778601\",\n \"countryOfOrigin\": \"SE\",\n \"supplierTags\": {\n \"supplierTag1\": \"07XXXXXXXX\",\n \"supplierTag2\": \"\",\n \"supplierTag3\": \"\",\n \"supplierTag4\": \"\"\n }\n },\n {\n \"supplierID\": \"2\",\n \"supplierName\": \"Telenor\",\n \"corporateIdentityNumber\": \"556421-0309\",\n \"bankAccountNumber\": \"5331-1338\",\n \"plusGiroNumber\": \"4792603-5\",\n \"iban\": \"SE2195000099603447926035\",\n \"vatNumber\": \"SE556421030901\",\n \"countryOfOrigin\": \"\"\n },\n {\n \"supplierID\": \"3\",\n \"supplierName\": \"Dutch Supplier B.V.\",\n \"corporateIdentityNumber\": \"12345678\",\n \"bankAccountNumber\": \"\",\n \"plusGiroNumber\": \"\",\n \"iban\": \"NL91ABNA0417164300\",\n \"vatNumber\": \"NL987654321B01\",\n \"countryOfOrigin\": \"NL\",\n \"supplierTags\": {\n \"supplierTag1\": \"+31207654321\",\n \"supplierTag2\": \"contact@dutchsupplier.nl\",\n \"supplierTag3\": \"\",\n \"supplierTag4\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/companies/:companyID/suppliers/multiple", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "suppliers", "multiple" ], "variable": [ { "key": "companyID" } ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\r\n \"objectList\": [\r\n {\r\n \"success\": false,\r\n \"data\": [\r\n {\r\n \"code\": 611401,\r\n \"message\": \"Supplier ID not found.\",\r\n \"details\": \"\",\r\n \"element\": \"supplierID\"\r\n },\r\n {\r\n \"code\": 611101,\r\n \"message\": \"All supplier specific parameters are either missing or invalid.\",\r\n \"details\": \"\",\r\n \"element\": \"\"\r\n }\r\n ],\r\n \"objectID\": \"1\"\r\n },\r\n {\r\n \"success\": true,\r\n \"data\": [\r\n {\r\n \"supplierID\": \"2\",\r\n \"supplierName\": \"Telenor\",\r\n \"corporateIdentityNumber\": \"556421-0309\",\r\n \"bankAccountNumber\": \"5331-1338\",\r\n \"plusGiroNumber\": \"4792603-5\",\r\n \"iban\": \"SE2195000099603447926035\",\r\n \"vatNumber\": \"SE556421030901\",\r\n \"countryOfOrigin\": \"\"\r\n }\r\n ],\r\n \"objectID\": \"2\"\r\n },\r\n {\r\n \"success\": true,\r\n \"data\": [\r\n {\r\n \"supplierID\": \"3\",\r\n \"supplierName\": \"Dutch Supplier B.V.\",\r\n \"corporateIdentityNumber\": \"12345678\",\r\n \"bankAccountNumber\": \"\",\r\n \"plusGiroNumber\": \"\",\r\n \"iban\": \"NL91ABNA0417164300\",\r\n \"vatNumber\": \"NL987654321B01\",\r\n \"countryOfOrigin\": \"NL\",\r\n \"supplierTags\": {\r\n \"supplierTag1\": \"+31207654321\",\r\n \"supplierTag2\": \"contact@dutchsupplier.nl\",\r\n \"supplierTag3\": \"\",\r\n \"supplierTag4\": \"\",\r\n \"supplierTag5\": \"\",\r\n \"supplierTag6\": \"\"\r\n }\r\n }\r\n ],\r\n \"objectID\": \"3\"\r\n }\r\n ],\r\n \"time\": \"2020-03-17 07:10:46\"\r\n}" }, { "name": "Internal Server Error", "originalRequest": { "method": "POST", "header": [ { "key": "Client-Key", "value": "{{clientKey}}", "description": "(Required) Your unique client key." }, { "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}", "description": "(Required) Your unique subscription key." }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"suppliers\": [\n {\n \"supplierID\": \"1\",\n \"supplierName\": \"Telavox\",\n \"corporateIdentityNumber\": \"556600-7786\",\n \"bankAccountNumber\": \"5677-6487\",\n \"plusGiroNumber\": \"\",\n \"iban\": \"SE1150000000056241002716\",\n \"vatNumber\": \"SE556600778601\",\n \"countryOfOrigin\": \"SE\",\n \"supplierTags\": {\n \"supplierTag1\": \"07XXXXXXXX\",\n \"supplierTag2\": \"\",\n \"supplierTag3\": \"\",\n \"supplierTag4\": \"\"\n }\n },\n {\n \"supplierID\": \"2\",\n \"supplierName\": \"Telenor\",\n \"corporateIdentityNumber\": \"556421-0309\",\n \"bankAccountNumber\": \"5331-1338\",\n \"plusGiroNumber\": \"4792603-5\",\n \"iban\": \"SE2195000099603447926035\",\n \"vatNumber\": \"SE556421030901\",\n \"countryOfOrigin\": \"\"\n },\n {\n \"supplierID\": \"3\",\n \"supplierName\": \"Dutch Supplier B.V.\",\n \"corporateIdentityNumber\": \"12345678\",\n \"bankAccountNumber\": \"\",\n \"plusGiroNumber\": \"\",\n \"iban\": \"NL91ABNA0417164300\",\n \"vatNumber\": \"NL987654321B01\",\n \"countryOfOrigin\": \"NL\",\n \"supplierTags\": {\n \"supplierTag1\": \"+31207654321\",\n \"supplierTag2\": \"contact@dutchsupplier.nl\",\n \"supplierTag3\": \"\",\n \"supplierTag4\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/companies/:companyID/suppliers/multiple", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "suppliers", "multiple" ], "variable": [ { "key": "companyID" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\r\n \"success\": false,\r\n \"data\": [\r\n {\r\n \"code\": 1009220,\r\n \"message\": \"Database operation failed.\",\r\n \"details\": \"\",\r\n \"element\": \"\"\r\n }\r\n ],\r\n \"extended\": \"\",\r\n \"meta\": \"\",\r\n \"origin\": \"\",\r\n \"time\": \"2020-07-28 07:45:27\"\r\n}" } ] }, { "name": "Retrieve a supplier", "request": { "method": "GET", "header": [ { "description": "(Required) Your unique client key.", "key": "Client-Key", "value": "{{clientKey}}" }, { "description": "(Required) Your unique subscription key.", "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}" } ], "url": { "raw": "{{baseUrl}}/companies/:companyID/suppliers/:supplierID", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "suppliers", ":supplierID" ], "variable": [ { "key": "companyID", "value": "1", "description": "(Required) The company's unique ID." }, { "key": "supplierID", "value": "1", "description": "(Required) The supplier's unique ID." } ] }, "description": "Retrieve a supplier." }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Client-Key", "value": "{{clientKey}}", "description": "(Required) Your unique client key." }, { "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}", "description": "(Required) Your unique subscription key." } ], "url": { "raw": "{{baseUrl}}/companies/:companyID/suppliers/:supplierID", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "suppliers", ":supplierID" ], "variable": [ { "key": "companyID" }, { "key": "supplierID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\r\n \"success\": true,\r\n \"data\": {\r\n \"supplierID\": \"1\",\r\n \"supplierName\": \"Telavoxii\",\r\n \"corporateIdentityNumber\": \"556600-7786\",\r\n \"bankAccountNumber\": \"5677-6487\",\r\n \"plusGiroNumber\": \"\",\r\n \"iban\": \"SE1150000000056241002716\",\r\n \"vatNumber\": \"\",\r\n \"countryOfOrigin\": \"\",\r\n \"supplierTags\": {\r\n \"supplierTag1\": \"\",\r\n \"supplierTag2\": \"\",\r\n \"supplierTag3\": \"\",\r\n \"supplierTag4\": \"\",\r\n \"supplierTag5\": \"\",\r\n \"supplierTag6\": \"\"\r\n }\r\n },\r\n \"extended\": \"\",\r\n \"meta\": \"\",\r\n \"origin\": \"\",\r\n \"time\": \"2026-08-05 09:22:35\"\r\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "key": "Client-Key", "value": "{{clientKey}}", "description": "(Required) Your unique client key." }, { "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}", "description": "(Required) Your unique subscription key." } ], "url": { "raw": "{{baseUrl}}/companies/:companyID/suppliers/:supplierID", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "suppliers", ":supplierID" ], "variable": [ { "key": "companyID" }, { "key": "supplierID" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\r\n \"success\": false,\r\n \"data\": [\r\n {\r\n \"code\": 111402,\r\n \"message\": \"Company ID is not valid.\",\r\n \"details\": \"\",\r\n \"element\": \"companyID\"\r\n }\r\n ],\r\n \"extended\": \"\",\r\n \"meta\": \"\",\r\n \"origin\": \"\",\r\n \"time\": \"2020-07-28 07:39:34\"\r\n}" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "key": "Client-Key", "value": "{{clientKey}}", "description": "(Required) Your unique client key." }, { "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}", "description": "(Required) Your unique subscription key." } ], "url": { "raw": "{{baseUrl}}/companies/:companyID/suppliers/:supplierID", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "suppliers", ":supplierID" ], "variable": [ { "key": "companyID" }, { "key": "supplierID" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\r\n \"success\": false,\r\n \"data\": [\r\n {\r\n \"code\": 611401,\r\n \"message\": \"Supplier ID not found.\",\r\n \"details\": \"\",\r\n \"element\": \"supplierID\"\r\n }\r\n ],\r\n \"extended\": \"\",\r\n \"meta\": \"\",\r\n \"origin\": \"\",\r\n \"time\": \"2020-07-28 07:40:48\"\r\n}" }, { "name": "Internal Server Error", "originalRequest": { "method": "GET", "header": [ { "key": "Client-Key", "value": "{{clientKey}}", "description": "(Required) Your unique client key." }, { "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}", "description": "(Required) Your unique subscription key." } ], "url": { "raw": "{{baseUrl}}/companies/:companyID/suppliers/:supplierID", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "suppliers", ":supplierID" ], "variable": [ { "key": "companyID" }, { "key": "supplierID" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\r\n \"success\": false,\r\n \"data\": [\r\n {\r\n \"code\": 1009220,\r\n \"message\": \"Database operation failed.\",\r\n \"details\": \"\",\r\n \"element\": \"\"\r\n }\r\n ],\r\n \"extended\": \"\",\r\n \"meta\": \"\",\r\n \"origin\": \"\",\r\n \"time\": \"2020-07-28 07:45:27\"\r\n}" } ] }, { "name": "Retrieve all suppliers", "request": { "method": "GET", "header": [ { "description": "(Required) Your unique client key.", "key": "Client-Key", "value": "{{clientKey}}" }, { "description": "(Required) Your unique subscription key.", "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}" } ], "url": { "raw": "{{baseUrl}}/companies/:companyID/suppliers", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "suppliers" ], "variable": [ { "key": "companyID", "value": "1", "description": "(Required) The company's unique ID." } ] }, "description": "Retrieve all suppliers." }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Client-Key", "value": "{{clientKey}}", "description": "(Required) Your unique client key." }, { "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}", "description": "(Required) Your unique subscription key." } ], "url": { "raw": "{{baseUrl}}/companies/:companyID/suppliers", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "suppliers" ], "variable": [ { "key": "companyID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\r\n \"success\": true,\r\n \"data\": {\r\n \"suppliers\": [\r\n {\r\n \"supplierID\": \"1\",\r\n \"supplierName\": \"Telavox\",\r\n \"corporateIdentityNumber\": \"556600-7786\",\r\n \"bankAccountNumber\": \"5677-6487\",\r\n \"plusGiroNumber\": \"\",\r\n \"iban\": \"SE1150000000056241002716\",\r\n \"vatNumber\": \"SE556600778601\",\r\n \"countryOfOrigin\": \"SE\",\r\n \"supplierTags\": {\r\n \"supplierTag1\": \"+46712345678\",\r\n \"supplierTag2\": \"example@email.com\",\r\n \"supplierTag3\": \"\",\r\n \"supplierTag4\": \"\",\r\n \"supplierTag5\": \"\",\r\n \"supplierTag6\": \"\"\r\n }\r\n },\r\n {\r\n \"supplierID\": \"2\",\r\n \"supplierName\": \"Telenor\",\r\n \"corporateIdentityNumber\": \"556421-0309\",\r\n \"bankAccountNumber\": \"5331-1338\",\r\n \"plusGiroNumber\": \"4792603-5\",\r\n \"iban\": \"SE2195000099603447926035\",\r\n \"vatNumber\": \"SE556421030901\",\r\n \"countryOfOrigin\": \"\"\r\n },\r\n {\r\n \"supplierID\": \"3\",\r\n \"supplierName\": \"Dutch Supplier B.V.\",\r\n \"corporateIdentityNumber\": \"12345678\",\r\n \"bankAccountNumber\": \"\",\r\n \"plusGiroNumber\": \"\",\r\n \"iban\": \"NL91ABNA0417164300\",\r\n \"vatNumber\": \"NL987654321B01\",\r\n \"countryOfOrigin\": \"NL\",\r\n \"supplierTags\": {\r\n \"supplierTag1\": \"+31207654321\",\r\n \"supplierTag2\": \"contact@dutchsupplier.nl\",\r\n \"supplierTag3\": \"\",\r\n \"supplierTag4\": \"\",\r\n \"supplierTag5\": \"\",\r\n \"supplierTag6\": \"\"\r\n }\r\n }\r\n ]\r\n },\r\n \"extended\": \"\",\r\n \"meta\": \"\",\r\n \"origin\": \"\",\r\n \"time\": \"2020-08-02 08:20:33\"\r\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "key": "Client-Key", "value": "{{clientKey}}", "description": "(Required) Your unique client key." }, { "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}", "description": "(Required) Your unique subscription key." } ], "url": { "raw": "{{baseUrl}}/companies/:companyID/suppliers", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "suppliers" ], "variable": [ { "key": "companyID" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\r\n \"success\": false,\r\n \"data\": [\r\n {\r\n \"code\": 111402,\r\n \"message\": \"Company ID is not valid.\",\r\n \"details\": \"\",\r\n \"element\": \"companyID\"\r\n }\r\n ],\r\n \"extended\": \"\",\r\n \"meta\": \"\",\r\n \"origin\": \"\",\r\n \"time\": \"2020-07-28 07:39:34\"\r\n}" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "key": "Client-Key", "value": "{{clientKey}}", "description": "(Required) Your unique client key." }, { "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}", "description": "(Required) Your unique subscription key." } ], "url": { "raw": "{{baseUrl}}/companies/:companyID/suppliers", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "suppliers" ], "variable": [ { "key": "companyID" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\r\n \"success\": false,\r\n \"data\": [\r\n {\r\n \"code\": 111401,\r\n \"message\": \"Company ID not found.\",\r\n \"details\": \"\",\r\n \"element\": \"companyID\"\r\n }\r\n ],\r\n \"extended\": \"\",\r\n \"meta\": \"\",\r\n \"origin\": \"\",\r\n \"time\": \"2020-07-28 07:40:48\"\r\n}" }, { "name": "Internal Server Error", "originalRequest": { "method": "GET", "header": [ { "key": "Client-Key", "value": "{{clientKey}}", "description": "(Required) Your unique client key." }, { "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}", "description": "(Required) Your unique subscription key." } ], "url": { "raw": "{{baseUrl}}/companies/:companyID/suppliers", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "suppliers" ], "variable": [ { "key": "companyID" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\r\n \"success\": false,\r\n \"data\": [\r\n {\r\n \"code\": 1009220,\r\n \"message\": \"Database operation failed.\",\r\n \"details\": \"\",\r\n \"element\": \"\"\r\n }\r\n ],\r\n \"extended\": \"\",\r\n \"meta\": \"\",\r\n \"origin\": \"\",\r\n \"time\": \"2020-07-28 07:45:27\"\r\n}" } ] }, { "name": "Update a supplier", "request": { "method": "PUT", "header": [ { "key": "Client-Key", "value": "{{clientKey}}", "description": "(Required) Your unique client key." }, { "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}", "description": "(Required) Your unique subscription key." }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\r\n \"supplierID\": \"1\",\r\n \"supplierName\": \"Telavox\",\r\n \"corporateIdentityNumber\": \"556600-7786\",\r\n \"bankAccountNumber\": \"5677-6487\",\r\n \"plusGiroNumber\": \"\",\r\n \"iban\": \"SE1150000000056241002716\",\r\n \"vatNumber\": \"SE556600778601\",\r\n \"countryOfOrigin\": \"SE\",\r\n \"supplierTags\": {\r\n \"supplierTag1\": \"+46712345678\",\r\n \"supplierTag2\": \"example@email.com\",\r\n \"supplierTag3\": \"\",\r\n \"supplierTag4\": \"\",\r\n \"supplierTag5\": \"\",\r\n \"supplierTag6\": \"\"\r\n }\r\n}" }, "url": { "raw": "{{baseUrl}}/companies/:companyID/suppliers/:supplierID", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "suppliers", ":supplierID" ], "variable": [ { "key": "companyID", "value": "1", "description": "(Required) The company's unique ID." }, { "key": "supplierID", "value": "1", "description": "(Required) The supplier's unique ID." } ] }, "description": "Update a supplier." }, "response": [ { "name": "OK", "originalRequest": { "method": "PUT", "header": [ { "key": "Client-Key", "value": "{{baseUrl}}", "description": "(Required) Your unique client key." }, { "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}", "description": "(Required) Your unique subscription key." }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"success\": true,\n \"data\": {\n \"supplierID\": \"1\",\n \"supplierName\": \"Telavox\",\n \"supplierTag1\": \"556600-7786\",\n \"supplierTag2\": \"5677-6487\",\n \"supplierTag3\": \"\",\n \"supplierTag4\": \"SE1150000000056241002716\"\n },\n \"extended\": \"\",\n \"meta\": \"\",\n \"time\": \"2020-03-21 01:41:02\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/companies/:companyID/suppliers/:supplierID", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "suppliers", ":supplierID" ], "variable": [ { "key": "companyID" }, { "key": "supplierID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\r\n \"success\": true,\r\n \"data\": {\r\n \"supplierID\": \"1\",\r\n \"supplierName\": \"Telavox\",\r\n \"corporateIdentityNumber\": \"556600-7786\",\r\n \"bankAccountNumber\": \"5677-6487\",\r\n \"plusGiroNumber\": \"\",\r\n \"iban\": \"\",\r\n \"vatNumber\": \"SE556600778601\",\r\n \"countryOfOrigin\": \"SE\",\r\n \"supplierTags\": {\r\n \"supplierTag1\": \"+46712345678\",\r\n \"supplierTag2\": \"example@email.com\",\r\n \"supplierTag3\": \"\",\r\n \"supplierTag4\": \"\",\r\n \"supplierTag5\": \"\",\r\n \"supplierTag6\": \"\"\r\n }\r\n },\r\n \"extended\": \"\",\r\n \"meta\": \"\",\r\n \"origin\": \"\",\r\n \"time\": \"2020-03-28 11:41:02\"\r\n}" }, { "name": "Bad Request", "originalRequest": { "method": "PUT", "header": [ { "key": "Client-Key", "value": "{{baseUrl}}", "description": "(Required) Your unique client key." }, { "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}", "description": "(Required) Your unique subscription key." }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"success\": true,\n \"data\": {\n \"supplierID\": \"1\",\n \"supplierName\": \"Telavox\",\n \"supplierTag1\": \"556600-7786\",\n \"supplierTag2\": \"5677-6487\",\n \"supplierTag3\": \"\",\n \"supplierTag4\": \"SE1150000000056241002716\"\n },\n \"extended\": \"\",\n \"meta\": \"\",\n \"time\": \"2020-03-21 01:41:02\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/companies/:companyID/suppliers/:supplierID", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "suppliers", ":supplierID" ], "variable": [ { "key": "companyID" }, { "key": "supplierID" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\r\n \"success\": false,\r\n \"data\": [\r\n {\r\n \"code\": 611402,\r\n \"message\": \"Supplier ID is not valid.\",\r\n \"details\": \"SupplierID parameter and SupplierID in Body mismatch.\",\r\n \"element\": \"supplierID\"\r\n }\r\n ],\r\n \"extended\": \"\",\r\n \"meta\": \"\",\r\n \"origin\": \"\",\r\n \"time\": \"2020-08-02 09:28:35\"\r\n}" }, { "name": "Not Found", "originalRequest": { "method": "PUT", "header": [ { "key": "Client-Key", "value": "{{baseUrl}}", "description": "(Required) Your unique client key." }, { "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}", "description": "(Required) Your unique subscription key." }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"success\": true,\n \"data\": {\n \"supplierID\": \"1\",\n \"supplierName\": \"Telavox\",\n \"supplierTag1\": \"556600-7786\",\n \"supplierTag2\": \"5677-6487\",\n \"supplierTag3\": \"\",\n \"supplierTag4\": \"SE1150000000056241002716\"\n },\n \"extended\": \"\",\n \"meta\": \"\",\n \"time\": \"2020-03-21 01:41:02\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/companies/:companyID/suppliers/:supplierID", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "suppliers", ":supplierID" ], "variable": [ { "key": "companyID" }, { "key": "supplierID" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\r\n \"success\": false,\r\n \"data\": [\r\n {\r\n \"code\": 611401,\r\n \"message\": \"Supplier ID not found.\",\r\n \"details\": \"\",\r\n \"element\": \"supplierID\"\r\n }\r\n ],\r\n \"extended\": \"\",\r\n \"meta\": \"\",\r\n \"origin\": \"\",\r\n \"time\": \"2020-07-28 07:40:48\"\r\n}" }, { "name": "Internal Server Error", "originalRequest": { "method": "PUT", "header": [ { "key": "Client-Key", "value": "{{baseUrl}}", "description": "(Required) Your unique client key." }, { "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}", "description": "(Required) Your unique subscription key." }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"success\": true,\n \"data\": {\n \"supplierID\": \"1\",\n \"supplierName\": \"Telavox\",\n \"supplierTag1\": \"556600-7786\",\n \"supplierTag2\": \"5677-6487\",\n \"supplierTag3\": \"\",\n \"supplierTag4\": \"SE1150000000056241002716\"\n },\n \"extended\": \"\",\n \"meta\": \"\",\n \"time\": \"2020-03-21 01:41:02\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/companies/:companyID/suppliers/:supplierID", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "suppliers", ":supplierID" ], "variable": [ { "key": "companyID" }, { "key": "supplierID" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\r\n \"success\": false,\r\n \"data\": [\r\n {\r\n \"code\": 1009220,\r\n \"message\": \"Database operation failed.\",\r\n \"details\": \"\",\r\n \"element\": \"\"\r\n }\r\n ],\r\n \"extended\": \"\",\r\n \"meta\": \"\",\r\n \"origin\": \"\",\r\n \"time\": \"2020-07-28 07:45:27\"\r\n}" } ] }, { "name": "Delete a supplier", "request": { "method": "DELETE", "header": [ { "description": "(Required) Your unique client key.", "key": "Client-Key", "value": "{{clientKey}}" }, { "description": "(Required) Your unique subscription key.", "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}" } ], "url": { "raw": "{{baseUrl}}/companies/:companyID/suppliers/:supplierID", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "suppliers", ":supplierID" ], "variable": [ { "key": "companyID", "value": "1", "description": "(Required) The company's unique ID." }, { "key": "supplierID", "value": "1", "description": "(Required) The supplier's unique ID." } ] }, "description": "Delete a supplier." }, "response": [ { "name": "OK", "originalRequest": { "method": "DELETE", "header": [ { "key": "Client-Key", "value": "{{clientKey}}", "description": "(Required) Your unique client key." }, { "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}", "description": "(Required) Your unique subscription key." } ], "url": { "raw": "{{baseUrl}}/companies/:companyID/suppliers/:supplierID", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "suppliers", ":supplierID" ], "variable": [ { "key": "companyID" }, { "key": "supplierID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\r\n \"success\": true,\r\n \"data\": {},\r\n \"extended\": \"\",\r\n \"meta\": \"\",\r\n \"origin\": \"\",\r\n \"time\": \"2020-03-28 11:41:02\"\r\n}" }, { "name": "Bad Request", "originalRequest": { "method": "DELETE", "header": [ { "key": "Client-Key", "value": "{{clientKey}}", "description": "(Required) Your unique client key." }, { "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}", "description": "(Required) Your unique subscription key." } ], "url": { "raw": "{{baseUrl}}/companies/:companyID/suppliers/:supplierID", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "suppliers", ":supplierID" ], "variable": [ { "key": "companyID" }, { "key": "supplierID" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\r\n \"success\": false,\r\n \"data\": [\r\n {\r\n \"code\": 111402,\r\n \"message\": \"Company ID is not valid.\",\r\n \"details\": \"\",\r\n \"element\": \"companyID\"\r\n }\r\n ],\r\n \"extended\": \"\",\r\n \"meta\": \"\",\r\n \"origin\": \"\",\r\n \"time\": \"2020-07-28 07:39:34\"\r\n}" }, { "name": "Not Found", "originalRequest": { "method": "DELETE", "header": [ { "key": "Client-Key", "value": "{{clientKey}}", "description": "(Required) Your unique client key." }, { "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}", "description": "(Required) Your unique subscription key." } ], "url": { "raw": "{{baseUrl}}/companies/:companyID/suppliers/:supplierID", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "suppliers", ":supplierID" ], "variable": [ { "key": "companyID" }, { "key": "supplierID" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\r\n \"success\": false,\r\n \"data\": [\r\n {\r\n \"code\": 611401,\r\n \"message\": \"Supplier ID not found.\",\r\n \"details\": \"\",\r\n \"element\": \"supplierID\"\r\n }\r\n ],\r\n \"extended\": \"\",\r\n \"meta\": \"\",\r\n \"origin\": \"\",\r\n \"time\": \"2020-07-28 07:40:48\"\r\n}" }, { "name": "Internal Server Error", "originalRequest": { "method": "DELETE", "header": [ { "key": "Client-Key", "value": "{{clientKey}}", "description": "(Required) Your unique client key." }, { "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}", "description": "(Required) Your unique subscription key." } ], "url": { "raw": "{{baseUrl}}/companies/:companyID/suppliers/:supplierID", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "suppliers", ":supplierID" ], "variable": [ { "key": "companyID" }, { "key": "supplierID" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\r\n \"success\": false,\r\n \"data\": [\r\n {\r\n \"code\": 1009220,\r\n \"message\": \"Database operation failed.\",\r\n \"details\": \"\",\r\n \"element\": \"\"\r\n }\r\n ],\r\n \"extended\": \"\",\r\n \"meta\": \"\",\r\n \"origin\": \"\",\r\n \"time\": \"2020-07-28 07:45:27\"\r\n}" } ] } ] }, { "name": "Supplier Invoices", "item": [ { "name": "Extract data from an invoice", "request": { "method": "GET", "header": [ { "key": "Client-Key", "value": "{{clientKey}}", "description": "(Required) Your unique client key." }, { "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}", "description": "(Required) Your unique subscription key." } ], "url": { "raw": "{{baseUrl}}/companies/:companyID/files/:fileID/supplierInvoices?verificationSeries=A&extended=true&origin", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "files", ":fileID", "supplierInvoices" ], "query": [ { "key": "verificationSeries", "value": "A", "description": "Extract data based on a specific verification series." }, { "key": "extended", "value": "true", "description": "When set to true, extended data will be provided in the response." }, { "key": "origin", "value": null, "description": "When set to true, origin data will be provided in the response.", "type": "text" } ], "variable": [ { "key": "companyID", "value": "1", "description": "(Required) The company's unique ID." }, { "key": "fileID", "value": "2", "description": "(Required) The file's unique ID." } ] }, "description": "Extract data from an invoice." }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Client-Key", "value": "{{clientKey}}", "description": "(Required) Your unique client key." }, { "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}", "description": "(Required) Your unique subscription key." } ], "url": { "raw": "{{baseUrl}}/companies/:companyID/files/:fileID/supplierInvoices?verificationSeries=A&extended=true&origin", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "files", ":fileID", "supplierInvoices" ], "query": [ { "key": "verificationSeries", "value": "A" }, { "key": "extended", "value": "true" }, { "key": "origin", "value": null } ], "variable": [ { "key": "companyID" }, { "key": "fileID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\r\n \"success\": true,\r\n \"data\": {\r\n \"supplierID\": \"1\",\r\n \"description\": \"Telavox invoice\",\r\n \"verificationSeries\": \"A\",\r\n \"invoiceDate\": \"2020-05-03\",\r\n \"dueDate\": \"\",\r\n \"invoiceNumber\": \"\",\r\n \"ocrNumber\": \"707902514856\",\r\n \"referenceNumber\": \"12345\",\r\n \"orderNumber\": \"12345\",\r\n \"ourRef\": \"Emma Example\",\r\n \"yourRef\": \"Tony Test\",\r\n \"totalSum\": \"3119,00\",\r\n \"vat\": \"623,82\",\r\n \"accounts\": [\r\n {\r\n \"account\": \"1790\",\r\n \"periodicity\": {\r\n \"offsetAccount\": \"6210\",\r\n \"startDate\": \"2020-05-01\",\r\n \"endDate\": \"2021-04-30\"\r\n },\r\n \"project\": {\r\n \"targetValue\": \"P657588\"\r\n },\r\n \"costBearer\": {\r\n \"targetValue\": \"10\"\r\n },\r\n \"resultsCentre\": {\r\n \"targetValue\": \"20\"\r\n },\r\n \"debit\": \"2495,29\",\r\n \"credit\": \"0,00\"\r\n },\r\n {\r\n \"account\": \"3740\",\r\n \"periodicity\": {\r\n \"offsetAccount\": \"\",\r\n \"startDate\": \"\",\r\n \"endDate\": \"\"\r\n },\r\n \"project\": {\r\n \"targetValue\": \"\"\r\n },\r\n \"costBearer\": {\r\n \"targetValue\": \"\"\r\n },\r\n \"resultsCentre\": {\r\n \"targetValue\": \"\"\r\n },\r\n \"debit\": \"0,00\",\r\n \"credit\": \"0,11\"\r\n }\r\n ]\r\n },\r\n \"extended\": {\r\n \"dates\": [\r\n \"2020-05-03\",\r\n \"2020-05-01\",\r\n \"2021-04-30\"\r\n ],\r\n \"times\": [\r\n \"2026-08-04\"\r\n ],\r\n \"emails\": [\r\n \"info@arkimera.se\"\r\n ],\r\n \"currencies\": [\r\n \"SEK\"\r\n ],\r\n \"creditCardNumbers\": [],\r\n \"corporateIdentityNumbers\": [\r\n \"556600-7786\"\r\n ],\r\n \"bankAccountNumbers\": [\r\n \"5677-6487\"\r\n ],\r\n \"plusGiroNumbers\": [],\r\n \"ibans\": [\r\n \"SE1150000000056241002716\",\r\n \"NL91ABNA0417164300\"\r\n ],\r\n \"bic\": [\r\n \"ESSESESS\"\r\n ],\r\n \"vatNumbersByCountry\": {\r\n \"SE\": [\r\n \"SE556600778601\",\r\n \"SE559108741501\"\r\n ],\r\n \"NL\": [\r\n \"NL001234567B01\"\r\n ]\r\n },\r\n \"corporateIdentityNumbersByCountry\": {\r\n \"SE\": [\r\n \"5566007786\",\r\n \"5020765649\"\r\n ],\r\n \"NL\": [\r\n \"12345678\"\r\n ]\r\n },\r\n \"countryOfOrigin\": \"SE\"\r\n },\r\n \"meta\": \"\",\r\n \"origin\": {\r\n \"ancestor\": {\r\n \"ancestorType\": \"None\",\r\n \"companyID\": \"23\"\r\n }\r\n },\r\n \"time\": \"2020-07-28 11:41:02\"\r\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "key": "Client-Key", "value": "{{clientKey}}", "description": "(Required) Your unique client key." }, { "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}", "description": "(Required) Your unique subscription key." } ], "url": { "raw": "{{baseUrl}}/companies/:companyID/files/:fileID/supplierInvoices?verificationSeries=A&extended=true&origin", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "files", ":fileID", "supplierInvoices" ], "query": [ { "key": "verificationSeries", "value": "A" }, { "key": "extended", "value": "true" }, { "key": "origin", "value": null } ], "variable": [ { "key": "companyID" }, { "key": "fileID" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\r\n \"success\": false,\r\n \"data\": [\r\n {\r\n \"code\": 111402,\r\n \"message\": \"Company ID is not valid.\",\r\n \"details\": \"\",\r\n \"element\": \"companyID\"\r\n }\r\n ],\r\n \"extended\": \"\",\r\n \"meta\": \"\",\r\n \"origin\": \"\",\r\n \"time\": \"2020-07-28 07:39:34\"\r\n}" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "key": "Client-Key", "value": "{{clientKey}}", "description": "(Required) Your unique client key." }, { "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}", "description": "(Required) Your unique subscription key." } ], "url": { "raw": "{{baseUrl}}/companies/:companyID/files/:fileID/supplierInvoices?verificationSeries=A&extended=true&origin", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "files", ":fileID", "supplierInvoices" ], "query": [ { "key": "verificationSeries", "value": "A" }, { "key": "extended", "value": "true" }, { "key": "origin", "value": null } ], "variable": [ { "key": "companyID" }, { "key": "fileID" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\r\n \"success\": false,\r\n \"data\": [\r\n {\r\n \"code\": 111401,\r\n \"message\": \"Company ID not found.\",\r\n \"details\": \"\",\r\n \"element\": \"companyID\"\r\n }\r\n ],\r\n \"extended\": \"\",\r\n \"meta\": \"\",\r\n \"origin\": \"\",\r\n \"time\": \"2020-07-28 07:40:48\"\r\n}" }, { "name": "Precondition Failed", "originalRequest": { "method": "GET", "header": [ { "key": "Client-Key", "value": "{{clientKey}}", "description": "(Required) Your unique client key." }, { "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}", "description": "(Required) Your unique subscription key." } ], "url": { "raw": "{{baseUrl}}/companies/:companyID/files/:fileID/supplierInvoices?verificationSeries=A&extended=true&origin", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "files", ":fileID", "supplierInvoices" ], "query": [ { "key": "verificationSeries", "value": "A" }, { "key": "extended", "value": "true" }, { "key": "origin", "value": null } ], "variable": [ { "key": "companyID" }, { "key": "fileID" } ] } }, "status": "Precondition Failed", "code": 412, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\r\n \"success\": false,\r\n \"data\": [\r\n {\r\n \"code\": 211215,\r\n \"message\": \"File is not ready for extraction.\",\r\n \"details\": \"\",\r\n \"element\": \"file\"\r\n }\r\n ],\r\n \"extended\": \"\",\r\n \"meta\": \"\",\r\n \"origin\": \"\",\r\n \"time\": \"2020-07-28 07:41:59\"\r\n}" }, { "name": "Internal Server Error", "originalRequest": { "method": "GET", "header": [ { "key": "Client-Key", "value": "{{clientKey}}", "description": "(Required) Your unique client key." }, { "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}", "description": "(Required) Your unique subscription key." } ], "url": { "raw": "{{baseUrl}}/companies/:companyID/files/:fileID/supplierInvoices?verificationSeries=A&extended=true&origin", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "files", ":fileID", "supplierInvoices" ], "query": [ { "key": "verificationSeries", "value": "A" }, { "key": "extended", "value": "true" }, { "key": "origin", "value": null } ], "variable": [ { "key": "companyID" }, { "key": "fileID" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\r\n \"success\": false,\r\n \"data\": [\r\n {\r\n \"code\": 1009220,\r\n \"message\": \"Database operation failed.\",\r\n \"details\": \"\",\r\n \"element\": \"\"\r\n }\r\n ],\r\n \"extended\": \"\",\r\n \"meta\": \"\",\r\n \"origin\": \"\",\r\n \"time\": \"2020-07-28 07:45:27\"\r\n}" } ] }, { "name": "Bookkeep an invoice", "request": { "method": "PUT", "header": [ { "key": "Client-Key", "value": "{{clientKey}}", "description": "(Required) Your unique client key." }, { "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}", "description": "(Required) Your unique subscription key." }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\r\n \"supplierID\": \"1\",\r\n \"description\": \"Telavox invoice\",\r\n \"verificationSeries\": \"A\",\r\n \"invoiceDate\": \"2020-05-03\",\r\n \"dueDate\": \"\",\r\n \"invoiceNumber\": \"\",\r\n \"ocrNumber\": \"707902514856\",\r\n \"referenceNumber\": \"12345\",\r\n \"orderNumber\": \"12345\",\r\n \"ourRef\": \"Emma Example\",\r\n \"yourRef\": \"Tony Test\",\r\n \"totalSum\": \"3119,00\",\r\n \"vat\": \"623,82\",\r\n \"accounts\": [\r\n {\r\n \"account\": \"1790\",\r\n \"periodicity\": {\r\n \"offsetAccount\": \"6210\",\r\n \"startDate\": \"2020-05-01\",\r\n \"endDate\": \"2021-04-30\"\r\n },\r\n \"project\": {\r\n \"targetValue\": \"P657588\"\r\n },\r\n \"costBearer\": {\r\n \"targetValue\": \"10\"\r\n },\r\n \"resultsCentre\": {\r\n \"targetValue\": \"20\"\r\n },\r\n \"debit\": \"2495,29\",\r\n \"credit\": \"0,00\"\r\n },\r\n {\r\n \"account\": \"3740\",\r\n \"periodicity\": {\r\n \"offsetAccount\": \"\",\r\n \"startDate\": \"\",\r\n \"endDate\": \"\"\r\n },\r\n \"project\": {\r\n \"targetValue\": \"\"\r\n },\r\n \"costBearer\": {\r\n \"targetValue\": \"\"\r\n },\r\n \"resultsCentre\": {\r\n \"targetValue\": \"\"\r\n },\r\n \"debit\": \"0,00\",\r\n \"credit\": \"0,11\"\r\n }\r\n ]\r\n}" }, "url": { "raw": "{{baseUrl}}/companies/:companyID/files/:fileID/supplierInvoices", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "files", ":fileID", "supplierInvoices" ], "variable": [ { "key": "companyID", "value": "1", "description": "(Required) The company's unique ID." }, { "key": "fileID", "value": "2", "description": "(Required) The file's unique ID." } ] }, "description": "Bookkeep an invoice." }, "response": [ { "name": "OK", "originalRequest": { "method": "PUT", "header": [ { "key": "Client-Key", "value": "{{clientKey}}", "description": "(Required) Your unique client key." }, { "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}", "description": "(Required) Your unique subscription key." }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"supplierID\": \"1\",\n \"description\": \"Telavox invoice\",\n \"verificationSeries\": \"A\",\n \"invoiceDate\": \"2020-05-03\",\n \"dueDate\": \"\",\n \"invoiceNumber\": \"\",\n \"ocrNumber\": \"707902514856\",\n \"referenceNumber\": \"12345\",\n \"orderNumber\": \"12345\",\n \"ourRef\": \"Emma Example\",\n \"yourRef\": \"Tony Test\",\n \"totalSum\": \"3119,00\",\n \"vat\": \"623,82\",\n \"accounts\": [\n {\n \"account\": \"1790\",\n \"periodicity\": {\n \"offsetAccount\": \"6210\",\n \"startDate\": \"2020-05-01\",\n \"endDate\": \"2021-04-30\"\n },\n \"project\": {\n \"targetValue\": \"P657588\"\n },\n \"costBearer\": {\n \"targetValue\": \"10\"\n },\n \"resultsCentre\": {\n \"targetValue\": \"20\"\n },\n \"debit\": \"2495,29\",\n \"credit\": \"0,00\"\n },\n {\n \"account\": \"3740\",\n \"periodicity\": {\n \"offsetAccount\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\"\n },\n \"project\": {\n \"targetValue\": \"\"\n },\n \"costBearer\": {\n \"targetValue\": \"\"\n },\n \"resultsCentre\": {\n \"targetValue\": \"\"\n },\n \"debit\": \"0,00\",\n \"credit\": \"0,11\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/companies/:companyID/files/:fileID/supplierInvoices", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "files", ":fileID", "supplierInvoices" ], "variable": [ { "key": "companyID" }, { "key": "fileID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\r\n \"success\": true,\r\n \"data\": {\r\n \"supplierID\": \"1\",\r\n \"description\": \"Telavox invoice\",\r\n \"verificationSeries\": \"A\",\r\n \"invoiceDate\": \"2020-05-03\",\r\n \"dueDate\": \"\",\r\n \"invoiceNumber\": \"\",\r\n \"ocrNumber\": \"707902514856\",\r\n \"referenceNumber\": \"12345\",\r\n \"orderNumber\": \"12345\",\r\n \"ourRef\": \"Emma Example\",\r\n \"yourRef\": \"Tony Test\",\r\n \"totalSum\": \"3119,00\",\r\n \"vat\": \"623,82\",\r\n \"accounts\": [\r\n {\r\n \"account\": \"1790\",\r\n \"periodicity\": {\r\n \"offsetAccount\": \"6210\",\r\n \"startDate\": \"2020-05-01\",\r\n \"endDate\": \"2021-04-30\"\r\n },\r\n \"project\": {\r\n \"targetValue\": \"P657588\"\r\n },\r\n \"costBearer\": {\r\n \"targetValue\": \"10\"\r\n },\r\n \"resultsCentre\": {\r\n \"targetValue\": \"20\"\r\n },\r\n \"debit\": \"2495,29\",\r\n \"credit\": \"0,00\"\r\n },\r\n {\r\n \"account\": \"3740\",\r\n \"periodicity\": {\r\n \"offsetAccount\": \"\",\r\n \"startDate\": \"\",\r\n \"endDate\": \"\"\r\n },\r\n \"project\": {\r\n \"targetValue\": \"\"\r\n },\r\n \"costBearer\": {\r\n \"targetValue\": \"\"\r\n },\r\n \"resultsCentre\": {\r\n \"targetValue\": \"\"\r\n },\r\n \"debit\": \"0,00\",\r\n \"credit\": \"0,11\"\r\n }\r\n ]\r\n },\r\n \"extended\": \"\",\r\n \"meta\": \"\",\r\n \"origin\": \"\",\r\n \"time\": \"2020-03-28 11:41:02\"\r\n}" }, { "name": "Bad Request", "originalRequest": { "method": "PUT", "header": [ { "key": "Client-Key", "value": "{{clientKey}}", "description": "(Required) Your unique client key." }, { "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}", "description": "(Required) Your unique subscription key." }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"supplierID\": \"1\",\n \"description\": \"Telavox invoice\",\n \"verificationSeries\": \"A\",\n \"invoiceDate\": \"2020-05-03\",\n \"dueDate\": \"\",\n \"invoiceNumber\": \"\",\n \"ocrNumber\": \"707902514856\",\n \"referenceNumber\": \"12345\",\n \"orderNumber\": \"12345\",\n \"ourRef\": \"Emma Example\",\n \"yourRef\": \"Tony Test\",\n \"totalSum\": \"3119,00\",\n \"vat\": \"623,82\",\n \"accounts\": [\n {\n \"account\": \"1790\",\n \"periodicity\": {\n \"offsetAccount\": \"6210\",\n \"startDate\": \"2020-05-01\",\n \"endDate\": \"2021-04-30\"\n },\n \"project\": {\n \"targetValue\": \"P657588\"\n },\n \"costBearer\": {\n \"targetValue\": \"10\"\n },\n \"resultsCentre\": {\n \"targetValue\": \"20\"\n },\n \"debit\": \"2495,29\",\n \"credit\": \"0,00\"\n },\n {\n \"account\": \"3740\",\n \"periodicity\": {\n \"offsetAccount\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\"\n },\n \"project\": {\n \"targetValue\": \"\"\n },\n \"costBearer\": {\n \"targetValue\": \"\"\n },\n \"resultsCentre\": {\n \"targetValue\": \"\"\n },\n \"debit\": \"0,00\",\n \"credit\": \"0,11\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/companies/:companyID/files/:fileID/supplierInvoices", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "files", ":fileID", "supplierInvoices" ], "variable": [ { "key": "companyID" }, { "key": "fileID" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\r\n \"success\": false,\r\n \"data\": [\r\n {\r\n \"code\": 311602,\r\n \"message\": \"Date is not valid.\",\r\n \"details\": \"\",\r\n \"element\": \"invoiceDate\"\r\n },\r\n {\r\n \"code\": 315492,\r\n \"message\": \"Debit and credit do not balance.\",\r\n \"details\": \"\",\r\n \"element\": \"\"\r\n }\r\n ],\r\n \"extended\": \"\",\r\n \"meta\": \"\",\r\n \"origin\": \"\",\r\n \"time\": \"2020-08-01 07:59:59\"\r\n}" }, { "name": "Not Found", "originalRequest": { "method": "PUT", "header": [ { "key": "Client-Key", "value": "{{clientKey}}", "description": "(Required) Your unique client key." }, { "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}", "description": "(Required) Your unique subscription key." }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"supplierID\": \"1\",\n \"description\": \"Telavox invoice\",\n \"verificationSeries\": \"A\",\n \"invoiceDate\": \"2020-05-03\",\n \"dueDate\": \"\",\n \"invoiceNumber\": \"\",\n \"ocrNumber\": \"707902514856\",\n \"referenceNumber\": \"12345\",\n \"orderNumber\": \"12345\",\n \"ourRef\": \"Emma Example\",\n \"yourRef\": \"Tony Test\",\n \"totalSum\": \"3119,00\",\n \"vat\": \"623,82\",\n \"accounts\": [\n {\n \"account\": \"1790\",\n \"periodicity\": {\n \"offsetAccount\": \"6210\",\n \"startDate\": \"2020-05-01\",\n \"endDate\": \"2021-04-30\"\n },\n \"project\": {\n \"targetValue\": \"P657588\"\n },\n \"costBearer\": {\n \"targetValue\": \"10\"\n },\n \"resultsCentre\": {\n \"targetValue\": \"20\"\n },\n \"debit\": \"2495,29\",\n \"credit\": \"0,00\"\n },\n {\n \"account\": \"3740\",\n \"periodicity\": {\n \"offsetAccount\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\"\n },\n \"project\": {\n \"targetValue\": \"\"\n },\n \"costBearer\": {\n \"targetValue\": \"\"\n },\n \"resultsCentre\": {\n \"targetValue\": \"\"\n },\n \"debit\": \"0,00\",\n \"credit\": \"0,11\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/companies/:companyID/files/:fileID/supplierInvoices", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "files", ":fileID", "supplierInvoices" ], "variable": [ { "key": "companyID" }, { "key": "fileID" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\r\n \"success\": false,\r\n \"data\": [\r\n {\r\n \"code\": 111401,\r\n \"message\": \"Company ID not found.\",\r\n \"details\": \"\",\r\n \"element\": \"companyID\"\r\n }\r\n ],\r\n \"extended\": \"\",\r\n \"meta\": \"\",\r\n \"origin\": \"\",\r\n \"time\": \"2020-07-28 07:40:48\"\r\n}" }, { "name": "Precondition Failed", "originalRequest": { "method": "PUT", "header": [ { "key": "Client-Key", "value": "{{clientKey}}", "description": "(Required) Your unique client key." }, { "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}", "description": "(Required) Your unique subscription key." }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"supplierID\": \"1\",\n \"description\": \"Telavox invoice\",\n \"verificationSeries\": \"A\",\n \"invoiceDate\": \"2020-05-03\",\n \"dueDate\": \"\",\n \"invoiceNumber\": \"\",\n \"ocrNumber\": \"707902514856\",\n \"referenceNumber\": \"12345\",\n \"orderNumber\": \"12345\",\n \"ourRef\": \"Emma Example\",\n \"yourRef\": \"Tony Test\",\n \"totalSum\": \"3119,00\",\n \"vat\": \"623,82\",\n \"accounts\": [\n {\n \"account\": \"1790\",\n \"periodicity\": {\n \"offsetAccount\": \"6210\",\n \"startDate\": \"2020-05-01\",\n \"endDate\": \"2021-04-30\"\n },\n \"project\": {\n \"targetValue\": \"P657588\"\n },\n \"costBearer\": {\n \"targetValue\": \"10\"\n },\n \"resultsCentre\": {\n \"targetValue\": \"20\"\n },\n \"debit\": \"2495,29\",\n \"credit\": \"0,00\"\n },\n {\n \"account\": \"3740\",\n \"periodicity\": {\n \"offsetAccount\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\"\n },\n \"project\": {\n \"targetValue\": \"\"\n },\n \"costBearer\": {\n \"targetValue\": \"\"\n },\n \"resultsCentre\": {\n \"targetValue\": \"\"\n },\n \"debit\": \"0,00\",\n \"credit\": \"0,11\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/companies/:companyID/files/:fileID/supplierInvoices", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "files", ":fileID", "supplierInvoices" ], "variable": [ { "key": "companyID" }, { "key": "fileID" } ] } }, "status": "Precondition Failed", "code": 412, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\r\n \"success\": false,\r\n \"data\": [\r\n {\r\n \"code\": 211215,\r\n \"message\": \"File is not ready for extraction.\",\r\n \"details\": \"\",\r\n \"element\": \"file\"\r\n }\r\n ],\r\n \"extended\": \"\",\r\n \"meta\": \"\",\r\n \"origin\": \"\",\r\n \"time\": \"2020-07-28 07:41:59\"\r\n}" }, { "name": "Internal Server Error", "originalRequest": { "method": "PUT", "header": [ { "key": "Client-Key", "value": "{{clientKey}}", "description": "(Required) Your unique client key." }, { "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}", "description": "(Required) Your unique subscription key." }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"supplierID\": \"1\",\n \"description\": \"Telavox invoice\",\n \"verificationSeries\": \"A\",\n \"invoiceDate\": \"2020-05-03\",\n \"dueDate\": \"\",\n \"invoiceNumber\": \"\",\n \"ocrNumber\": \"707902514856\",\n \"referenceNumber\": \"12345\",\n \"orderNumber\": \"12345\",\n \"ourRef\": \"Emma Example\",\n \"yourRef\": \"Tony Test\",\n \"totalSum\": \"3119,00\",\n \"vat\": \"623,82\",\n \"accounts\": [\n {\n \"account\": \"1790\",\n \"periodicity\": {\n \"offsetAccount\": \"6210\",\n \"startDate\": \"2020-05-01\",\n \"endDate\": \"2021-04-30\"\n },\n \"project\": {\n \"targetValue\": \"P657588\"\n },\n \"costBearer\": {\n \"targetValue\": \"10\"\n },\n \"resultsCentre\": {\n \"targetValue\": \"20\"\n },\n \"debit\": \"2495,29\",\n \"credit\": \"0,00\"\n },\n {\n \"account\": \"3740\",\n \"periodicity\": {\n \"offsetAccount\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\"\n },\n \"project\": {\n \"targetValue\": \"\"\n },\n \"costBearer\": {\n \"targetValue\": \"\"\n },\n \"resultsCentre\": {\n \"targetValue\": \"\"\n },\n \"debit\": \"0,00\",\n \"credit\": \"0,11\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/companies/:companyID/files/:fileID/supplierInvoices", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "files", ":fileID", "supplierInvoices" ], "variable": [ { "key": "companyID" }, { "key": "fileID" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\r\n \"success\": false,\r\n \"data\": [\r\n {\r\n \"code\": 1009220,\r\n \"message\": \"Database operation failed.\",\r\n \"details\": \"\",\r\n \"element\": \"\"\r\n }\r\n ],\r\n \"extended\": \"\",\r\n \"meta\": \"\",\r\n \"origin\": \"\",\r\n \"time\": \"2020-07-28 07:45:27\"\r\n}" } ] } ] }, { "name": "Receipts", "item": [ { "name": "Extract data from a receipt", "request": { "method": "GET", "header": [ { "key": "Client-Key", "value": "{{clientKey}}", "description": "(Required) Your unique client key." }, { "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}", "description": "(Required) Your unique subscription key." } ], "url": { "raw": "{{baseUrl}}/companies/:companyID/files/:fileID/receipts?verificationSeries=A&extended=true&origin", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "files", ":fileID", "receipts" ], "query": [ { "key": "verificationSeries", "value": "A", "description": "Extract data based on a specific verification series." }, { "key": "extended", "value": "true", "description": "When set to true, extended data will be provided in the response." }, { "key": "origin", "value": null, "description": "When set to true, origin data will be provided in the response.", "type": "text" } ], "variable": [ { "key": "companyID", "value": "1", "description": "(Required) The company's unique ID." }, { "key": "fileID", "value": "1", "description": "(Required) The file's unique ID." } ] }, "description": "Extract data from a receipt." }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Client-Key", "value": "{{clientKey}}", "description": "(Required) Your unique client key." }, { "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}", "description": "(Required) Your unique subscription key." } ], "url": { "raw": "{{baseUrl}}/companies/:companyID/files/:fileID/receipts?verificationSeries=A&extended=true&origin", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "files", ":fileID", "receipts" ], "query": [ { "key": "verificationSeries", "value": "A" }, { "key": "extended", "value": "true" }, { "key": "origin", "value": null } ], "variable": [ { "key": "companyID" }, { "key": "fileID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\r\n \"success\": true,\r\n \"data\": {\r\n \"description\": \"Employee breakfast\",\r\n \"verificationSeries\": \"A\",\r\n \"receiptDate\": \"2020-05-04\",\r\n \"accounts\": [\r\n {\r\n \"account\": \"1930\",\r\n \"periodicity\": {\r\n \"offsetAccount\": \"\",\r\n \"startDate\": \"\",\r\n \"endDate\": \"\"\r\n },\r\n \"project\": {\r\n \"targetValue\": \"\"\r\n },\r\n \"costBearer\": {\r\n \"targetValue\": \"\"\r\n },\r\n \"resultsCentre\": {\r\n \"targetValue\": \"\"\r\n },\r\n \"debit\": \"0,00\",\r\n \"credit\": \"3119,00\"\r\n },\r\n {\r\n \"account\": \"2641\",\r\n \"periodicity\": {\r\n \"offsetAccount\": \"\",\r\n \"startDate\": \"\",\r\n \"endDate\": \"\"\r\n },\r\n \"project\": {\r\n \"targetValue\": \"\"\r\n },\r\n \"costBearer\": {\r\n \"targetValue\": \"\"\r\n },\r\n \"resultsCentre\": {\r\n \"targetValue\": \"\"\r\n },\r\n \"debit\": \"623,82\",\r\n \"credit\": \"0,00\"\r\n },\r\n {\r\n \"account\": \"1790\",\r\n \"periodicity\": {\r\n \"offsetAccount\": \"6210\",\r\n \"startDate\": \"2020-05-01\",\r\n \"endDate\": \"2021-04-30\"\r\n },\r\n \"project\": {\r\n \"targetValue\": \"P657588\"\r\n },\r\n \"costBearer\": {\r\n \"targetValue\": \"10\"\r\n },\r\n \"resultsCentre\": {\r\n \"targetValue\": \"20\"\r\n },\r\n \"debit\": \"2495,29\",\r\n \"credit\": \"0,00\"\r\n },\r\n {\r\n \"account\": \"3740\",\r\n \"periodicity\": {\r\n \"offsetAccount\": \"\",\r\n \"startDate\": \"\",\r\n \"endDate\": \"\"\r\n },\r\n \"project\": {\r\n \"targetValue\": \"\"\r\n },\r\n \"costBearer\": {\r\n \"targetValue\": \"\"\r\n },\r\n \"resultsCentre\": {\r\n \"targetValue\": \"\"\r\n },\r\n \"debit\": \"0,00\",\r\n \"credit\": \"0,11\"\r\n }\r\n ]\r\n },\r\n \"extended\": {\r\n \"dates\": [\r\n \"2020-05-03\",\r\n \"2020-05-01\",\r\n \"2021-04-30\"\r\n ],\r\n \"times\": [\r\n \"2026-08-04\"\r\n ],\r\n \"emails\": [\r\n \"info@arkimera.se\"\r\n ],\r\n \"currencies\": [\r\n \"SEK\"\r\n ],\r\n \"creditCardNumbers\": [\r\n \"0982-01-01\"\r\n ],\r\n \"corporateIdentityNumbers\": [\r\n \"556550-5681\"\r\n ],\r\n \"ibans\": [\r\n \"SE1150000000056241002716\",\r\n \"NL91ABNA0417164300\"\r\n ],\r\n \"bic\": [\r\n \"ESSESESS\"\r\n ],\r\n \"vatNumbersByCountry\": {\r\n \"SE\": [\r\n \"SE556600778601\",\r\n \"SE559108741501\"\r\n ],\r\n \"NL\": [\r\n \"NL001234567B01\"\r\n ]\r\n },\r\n \"corporateIdentityNumbersByCountry\": {\r\n \"SE\": [\r\n \"5566007786\",\r\n \"5020765649\"\r\n ],\r\n \"NL\": [\r\n \"12345678\"\r\n ]\r\n },\r\n \"countryOfOrigin\": \"SE\"\r\n },\r\n \"meta\": \"\",\r\n \"origin\": {\r\n \"ancestor\": {\r\n \"ancestorType\": \"None\",\r\n \"companyID\": \"19\"\r\n }\r\n },\r\n \"time\": \"2026-08-06 10:20:00\"\r\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "key": "Client-Key", "value": "{{clientKey}}", "description": "(Required) Your unique client key." }, { "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}", "description": "(Required) Your unique subscription key." } ], "url": { "raw": "{{baseUrl}}/companies/:companyID/files/:fileID/receipts?verificationSeries=A&extended=true&origin", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "files", ":fileID", "receipts" ], "query": [ { "key": "verificationSeries", "value": "A" }, { "key": "extended", "value": "true" }, { "key": "origin", "value": null } ], "variable": [ { "key": "companyID" }, { "key": "fileID" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\r\n \"success\": false,\r\n \"data\": [\r\n {\r\n \"code\": 111402,\r\n \"message\": \"Company ID is not valid.\",\r\n \"details\": \"\",\r\n \"element\": \"companyID\"\r\n }\r\n ],\r\n \"extended\": \"\",\r\n \"meta\": \"\",\r\n \"origin\": \"\",\r\n \"time\": \"2026-08-06 10:20:30\"\r\n}" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "key": "Client-Key", "value": "{{clientKey}}", "description": "(Required) Your unique client key." }, { "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}", "description": "(Required) Your unique subscription key." } ], "url": { "raw": "{{baseUrl}}/companies/:companyID/files/:fileID/receipts?verificationSeries=A&extended=true&origin", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "files", ":fileID", "receipts" ], "query": [ { "key": "verificationSeries", "value": "A" }, { "key": "extended", "value": "true" }, { "key": "origin", "value": null } ], "variable": [ { "key": "companyID" }, { "key": "fileID" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\r\n \"success\": false,\r\n \"data\": [\r\n {\r\n \"code\": 111401,\r\n \"message\": \"Company ID not found.\",\r\n \"details\": \"\",\r\n \"element\": \"companyID\"\r\n }\r\n ],\r\n \"extended\": \"\",\r\n \"meta\": \"\",\r\n \"origin\": \"\",\r\n \"time\": \"2026-08-06 10:22:00\"\r\n}" }, { "name": "Precondition Failed", "originalRequest": { "method": "GET", "header": [ { "key": "Client-Key", "value": "{{clientKey}}", "description": "(Required) Your unique client key." }, { "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}", "description": "(Required) Your unique subscription key." } ], "url": { "raw": "{{baseUrl}}/companies/:companyID/files/:fileID/receipts?verificationSeries=A&extended=true&origin", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "files", ":fileID", "receipts" ], "query": [ { "key": "verificationSeries", "value": "A" }, { "key": "extended", "value": "true" }, { "key": "origin", "value": null } ], "variable": [ { "key": "companyID" }, { "key": "fileID" } ] } }, "status": "Precondition Failed", "code": 412, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\r\n \"success\": false,\r\n \"data\": [\r\n {\r\n \"code\": 211215,\r\n \"message\": \"File is not ready for extraction.\",\r\n \"details\": \"\",\r\n \"element\": \"file\"\r\n }\r\n ],\r\n \"extended\": \"\",\r\n \"meta\": \"\",\r\n \"origin\": \"\",\r\n \"time\": \"2026-08-06 10:22:30\"\r\n}" }, { "name": "Internal Server Error", "originalRequest": { "method": "GET", "header": [ { "key": "Client-Key", "value": "{{clientKey}}", "description": "(Required) Your unique client key." }, { "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}", "description": "(Required) Your unique subscription key." } ], "url": { "raw": "{{baseUrl}}/companies/:companyID/files/:fileID/receipts?verificationSeries=A&extended=true&origin", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "files", ":fileID", "receipts" ], "query": [ { "key": "verificationSeries", "value": "A" }, { "key": "extended", "value": "true" }, { "key": "origin", "value": null } ], "variable": [ { "key": "companyID" }, { "key": "fileID" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\r\n \"success\": false,\r\n \"data\": [\r\n {\r\n \"code\": 1009220,\r\n \"message\": \"Database operation failed.\",\r\n \"details\": \"\",\r\n \"element\": \"\"\r\n }\r\n ],\r\n \"extended\": \"\",\r\n \"meta\": \"\",\r\n \"origin\": \"\",\r\n \"time\": \"2020-07-28 07:45:27\"\r\n}" } ] }, { "name": "Bookkeep a receipt", "request": { "method": "PUT", "header": [ { "key": "Client-Key", "value": "{{clientKey}}", "description": "(Required) Your unique client key." }, { "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}", "description": "(Required) Your unique subscription key." }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\r\n \"description\": \"Employee breakfast\",\r\n \"verificationSeries\": \"A\",\r\n \"receiptDate\": \"2020-05-04\",\r\n \"accounts\": [\r\n {\r\n \"account\": \"1930\",\r\n \"periodicity\": {\r\n \"offsetAccount\": \"\",\r\n \"startDate\": \"\",\r\n \"endDate\": \"\"\r\n },\r\n \"project\": {\r\n \"targetValue\": \"\"\r\n },\r\n \"costBearer\": {\r\n \"targetValue\": \"\"\r\n },\r\n \"resultsCentre\": {\r\n \"targetValue\": \"\"\r\n },\r\n \"debit\": \"0,00\",\r\n \"credit\": \"3119,00\"\r\n },\r\n {\r\n \"account\": \"2641\",\r\n \"periodicity\": {\r\n \"offsetAccount\": \"\",\r\n \"startDate\": \"\",\r\n \"endDate\": \"\"\r\n },\r\n \"project\": {\r\n \"targetValue\": \"\"\r\n },\r\n \"costBearer\": {\r\n \"targetValue\": \"\"\r\n },\r\n \"resultsCentre\": {\r\n \"targetValue\": \"\"\r\n },\r\n \"debit\": \"623,82\",\r\n \"credit\": \"0,00\"\r\n },\r\n {\r\n \"account\": \"1790\",\r\n \"periodicity\": {\r\n \"offsetAccount\": \"6210\",\r\n \"startDate\": \"2020-05-01\",\r\n \"endDate\": \"2021-04-30\"\r\n },\r\n \"project\": {\r\n \"targetValue\": \"P657588\"\r\n },\r\n \"costBearer\": {\r\n \"targetValue\": \"10\"\r\n },\r\n \"resultsCentre\": {\r\n \"targetValue\": \"20\"\r\n },\r\n \"debit\": \"2495,29\",\r\n \"credit\": \"0,00\"\r\n },\r\n {\r\n \"account\": \"3740\",\r\n \"periodicity\": {\r\n \"offsetAccount\": \"\",\r\n \"startDate\": \"\",\r\n \"endDate\": \"\"\r\n },\r\n \"project\": {\r\n \"targetValue\": \"\"\r\n },\r\n \"costBearer\": {\r\n \"targetValue\": \"\"\r\n },\r\n \"resultsCentre\": {\r\n \"targetValue\": \"\"\r\n },\r\n \"debit\": \"0,00\",\r\n \"credit\": \"0,11\"\r\n }\r\n ]\r\n}" }, "url": { "raw": "{{baseUrl}}/companies/:companyID/files/:fileID/receipts", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "files", ":fileID", "receipts" ], "variable": [ { "key": "companyID", "value": "1", "description": "(Required) The company's unique ID." }, { "key": "fileID", "value": "1", "description": "(Required) The file's unique ID." } ] }, "description": "Bookkeep a receipt." }, "response": [ { "name": "OK", "originalRequest": { "method": "PUT", "header": [ { "key": "Client-Key", "value": "{{clientKey}}", "description": "(Required) Your unique client key." }, { "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}", "description": "(Required) Your unique subscription key." }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"description\": \"Employee breakfast\",\n \"verificationSeries\": \"A\",\n \"receiptDate\": \"2020-05-04\",\n \"accounts\": [\n {\n \"account\": \"1930\",\n \"periodicity\": {\n \"offsetAccount\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\"\n },\n \"project\": {\n \"targetValue\": \"\"\n },\n \"costBearer\": {\n \"targetValue\": \"\"\n },\n \"resultsCentre\": {\n \"targetValue\": \"\"\n },\n \"debit\": \"0,00\",\n \"credit\": \"3119,00\"\n },\n {\n \"account\": \"2641\",\n \"periodicity\": {\n \"offsetAccount\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\"\n },\n \"project\": {\n \"targetValue\": \"\"\n },\n \"costBearer\": {\n \"targetValue\": \"\"\n },\n \"resultsCentre\": {\n \"targetValue\": \"\"\n },\n \"debit\": \"623,82\",\n \"credit\": \"0,00\"\n },\n {\n \"account\": \"1790\",\n \"periodicity\": {\n \"offsetAccount\": \"6210\",\n \"startDate\": \"2020-05-01\",\n \"endDate\": \"2021-04-30\"\n },\n \"project\": {\n \"targetValue\": \"P657588\"\n },\n \"costBearer\": {\n \"targetValue\": \"10\"\n },\n \"resultsCentre\": {\n \"targetValue\": \"20\"\n },\n \"debit\": \"2495,29\",\n \"credit\": \"0,00\"\n },\n {\n \"account\": \"3740\",\n \"periodicity\": {\n \"offsetAccount\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\"\n },\n \"project\": {\n \"targetValue\": \"\"\n },\n \"costBearer\": {\n \"targetValue\": \"\"\n },\n \"resultsCentre\": {\n \"targetValue\": \"\"\n },\n \"debit\": \"0,00\",\n \"credit\": \"0,11\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/companies/:companyID/files/:fileID/receipts", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "files", ":fileID", "receipts" ], "variable": [ { "key": "companyID" }, { "key": "fileID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\r\n \"success\": true,\r\n \"data\": {\r\n \"description\": \"Employee breakfast\",\r\n \"verificationSeries\": \"A\",\r\n \"receiptDate\": \"2020-05-04\",\r\n \"accounts\": [\r\n {\r\n \"account\": \"1930\",\r\n \"periodicity\": {\r\n \"offsetAccount\": \"\",\r\n \"startDate\": \"\",\r\n \"endDate\": \"\"\r\n },\r\n \"project\": {\r\n \"targetValue\": \"\"\r\n },\r\n \"costBearer\": {\r\n \"targetValue\": \"\"\r\n },\r\n \"resultsCentre\": {\r\n \"targetValue\": \"\"\r\n },\r\n \"debit\": \"0,00\",\r\n \"credit\": \"3119,00\"\r\n },\r\n {\r\n \"account\": \"2641\",\r\n \"periodicity\": {\r\n \"offsetAccount\": \"\",\r\n \"startDate\": \"\",\r\n \"endDate\": \"\"\r\n },\r\n \"project\": {\r\n \"targetValue\": \"\"\r\n },\r\n \"costBearer\": {\r\n \"targetValue\": \"\"\r\n },\r\n \"resultsCentre\": {\r\n \"targetValue\": \"\"\r\n },\r\n \"debit\": \"623,82\",\r\n \"credit\": \"0,00\"\r\n },\r\n {\r\n \"account\": \"1790\",\r\n \"periodicity\": {\r\n \"offsetAccount\": \"6210\",\r\n \"startDate\": \"2020-05-01\",\r\n \"endDate\": \"2021-04-30\"\r\n },\r\n \"project\": {\r\n \"targetValue\": \"P657588\"\r\n },\r\n \"costBearer\": {\r\n \"targetValue\": \"10\"\r\n },\r\n \"resultsCentre\": {\r\n \"targetValue\": \"20\"\r\n },\r\n \"debit\": \"2495,29\",\r\n \"credit\": \"0,00\"\r\n },\r\n {\r\n \"account\": \"3740\",\r\n \"periodicity\": {\r\n \"offsetAccount\": \"\",\r\n \"startDate\": \"\",\r\n \"endDate\": \"\"\r\n },\r\n \"project\": {\r\n \"targetValue\": \"\"\r\n },\r\n \"costBearer\": {\r\n \"targetValue\": \"\"\r\n },\r\n \"resultsCentre\": {\r\n \"targetValue\": \"\"\r\n },\r\n \"debit\": \"0,00\",\r\n \"credit\": \"0,11\"\r\n }\r\n ]\r\n },\r\n \"extended\": \"\",\r\n \"meta\": \"\",\r\n \"origin\": \"\",\r\n \"time\": \"2026-08-06 10:30:00\"\r\n}" }, { "name": "Bad Request", "originalRequest": { "method": "PUT", "header": [ { "key": "Client-Key", "value": "{{clientKey}}", "description": "(Required) Your unique client key." }, { "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}", "description": "(Required) Your unique subscription key." }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"description\": \"Employee breakfast\",\n \"verificationSeries\": \"A\",\n \"receiptDate\": \"2020-05-04\",\n \"accounts\": [\n {\n \"account\": \"1930\",\n \"periodicity\": {\n \"offsetAccount\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\"\n },\n \"project\": {\n \"targetValue\": \"\"\n },\n \"costBearer\": {\n \"targetValue\": \"\"\n },\n \"resultsCentre\": {\n \"targetValue\": \"\"\n },\n \"debit\": \"0,00\",\n \"credit\": \"3119,00\"\n },\n {\n \"account\": \"2641\",\n \"periodicity\": {\n \"offsetAccount\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\"\n },\n \"project\": {\n \"targetValue\": \"\"\n },\n \"costBearer\": {\n \"targetValue\": \"\"\n },\n \"resultsCentre\": {\n \"targetValue\": \"\"\n },\n \"debit\": \"623,82\",\n \"credit\": \"0,00\"\n },\n {\n \"account\": \"1790\",\n \"periodicity\": {\n \"offsetAccount\": \"6210\",\n \"startDate\": \"2020-05-01\",\n \"endDate\": \"2021-04-30\"\n },\n \"project\": {\n \"targetValue\": \"P657588\"\n },\n \"costBearer\": {\n \"targetValue\": \"10\"\n },\n \"resultsCentre\": {\n \"targetValue\": \"20\"\n },\n \"debit\": \"2495,29\",\n \"credit\": \"0,00\"\n },\n {\n \"account\": \"3740\",\n \"periodicity\": {\n \"offsetAccount\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\"\n },\n \"project\": {\n \"targetValue\": \"\"\n },\n \"costBearer\": {\n \"targetValue\": \"\"\n },\n \"resultsCentre\": {\n \"targetValue\": \"\"\n },\n \"debit\": \"0,00\",\n \"credit\": \"0,11\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/companies/:companyID/files/:fileID/receipts", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "files", ":fileID", "receipts" ], "variable": [ { "key": "companyID" }, { "key": "fileID" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\r\n \"success\": false,\r\n \"data\": [\r\n {\r\n \"code\": 411802,\r\n \"message\": \"Description is not valid.\",\r\n \"details\": \"\",\r\n \"element\": \"description\"\r\n },\r\n {\r\n \"code\": 411602,\r\n \"message\": \"Date is not valid.\",\r\n \"details\": \"\",\r\n \"element\": \"receiptDate\"\r\n }\r\n ],\r\n \"extended\": \"\",\r\n \"meta\": \"\",\r\n \"origin\": \"\",\r\n \"time\": \"2026-08-06 10:30:30\"\r\n}" }, { "name": "Not Found", "originalRequest": { "method": "PUT", "header": [ { "key": "Client-Key", "value": "{{clientKey}}", "description": "(Required) Your unique client key." }, { "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}", "description": "(Required) Your unique subscription key." }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"description\": \"Employee breakfast\",\n \"verificationSeries\": \"A\",\n \"receiptDate\": \"2020-05-04\",\n \"accounts\": [\n {\n \"account\": \"1930\",\n \"periodicity\": {\n \"offsetAccount\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\"\n },\n \"project\": {\n \"targetValue\": \"\"\n },\n \"costBearer\": {\n \"targetValue\": \"\"\n },\n \"resultsCentre\": {\n \"targetValue\": \"\"\n },\n \"debit\": \"0,00\",\n \"credit\": \"3119,00\"\n },\n {\n \"account\": \"2641\",\n \"periodicity\": {\n \"offsetAccount\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\"\n },\n \"project\": {\n \"targetValue\": \"\"\n },\n \"costBearer\": {\n \"targetValue\": \"\"\n },\n \"resultsCentre\": {\n \"targetValue\": \"\"\n },\n \"debit\": \"623,82\",\n \"credit\": \"0,00\"\n },\n {\n \"account\": \"1790\",\n \"periodicity\": {\n \"offsetAccount\": \"6210\",\n \"startDate\": \"2020-05-01\",\n \"endDate\": \"2021-04-30\"\n },\n \"project\": {\n \"targetValue\": \"P657588\"\n },\n \"costBearer\": {\n \"targetValue\": \"10\"\n },\n \"resultsCentre\": {\n \"targetValue\": \"20\"\n },\n \"debit\": \"2495,29\",\n \"credit\": \"0,00\"\n },\n {\n \"account\": \"3740\",\n \"periodicity\": {\n \"offsetAccount\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\"\n },\n \"project\": {\n \"targetValue\": \"\"\n },\n \"costBearer\": {\n \"targetValue\": \"\"\n },\n \"resultsCentre\": {\n \"targetValue\": \"\"\n },\n \"debit\": \"0,00\",\n \"credit\": \"0,11\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/companies/:companyID/files/:fileID/receipts", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "files", ":fileID", "receipts" ], "variable": [ { "key": "companyID" }, { "key": "fileID" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\r\n \"success\": false,\r\n \"data\": [\r\n {\r\n \"code\": 111401,\r\n \"message\": \"Company ID not found.\",\r\n \"details\": \"\",\r\n \"element\": \"companyID\"\r\n }\r\n ],\r\n \"extended\": \"\",\r\n \"meta\": \"\",\r\n \"origin\": \"\",\r\n \"time\": \"2026-08-06 10:31:00\"\r\n}" }, { "name": "Precondition Failed", "originalRequest": { "method": "PUT", "header": [ { "key": "Client-Key", "value": "{{clientKey}}", "description": "(Required) Your unique client key." }, { "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}", "description": "(Required) Your unique subscription key." }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"description\": \"Employee breakfast\",\n \"verificationSeries\": \"A\",\n \"receiptDate\": \"2020-05-04\",\n \"accounts\": [\n {\n \"account\": \"1930\",\n \"periodicity\": {\n \"offsetAccount\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\"\n },\n \"project\": {\n \"targetValue\": \"\"\n },\n \"costBearer\": {\n \"targetValue\": \"\"\n },\n \"resultsCentre\": {\n \"targetValue\": \"\"\n },\n \"debit\": \"0,00\",\n \"credit\": \"3119,00\"\n },\n {\n \"account\": \"2641\",\n \"periodicity\": {\n \"offsetAccount\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\"\n },\n \"project\": {\n \"targetValue\": \"\"\n },\n \"costBearer\": {\n \"targetValue\": \"\"\n },\n \"resultsCentre\": {\n \"targetValue\": \"\"\n },\n \"debit\": \"623,82\",\n \"credit\": \"0,00\"\n },\n {\n \"account\": \"1790\",\n \"periodicity\": {\n \"offsetAccount\": \"6210\",\n \"startDate\": \"2020-05-01\",\n \"endDate\": \"2021-04-30\"\n },\n \"project\": {\n \"targetValue\": \"P657588\"\n },\n \"costBearer\": {\n \"targetValue\": \"10\"\n },\n \"resultsCentre\": {\n \"targetValue\": \"20\"\n },\n \"debit\": \"2495,29\",\n \"credit\": \"0,00\"\n },\n {\n \"account\": \"3740\",\n \"periodicity\": {\n \"offsetAccount\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\"\n },\n \"project\": {\n \"targetValue\": \"\"\n },\n \"costBearer\": {\n \"targetValue\": \"\"\n },\n \"resultsCentre\": {\n \"targetValue\": \"\"\n },\n \"debit\": \"0,00\",\n \"credit\": \"0,11\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/companies/:companyID/files/:fileID/receipts", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "files", ":fileID", "receipts" ], "variable": [ { "key": "companyID" }, { "key": "fileID" } ] } }, "status": "Precondition Failed", "code": 412, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\r\n \"success\": false,\r\n \"data\": [\r\n {\r\n \"code\": 211215,\r\n \"message\": \"File is not ready for extraction.\",\r\n \"details\": \"\",\r\n \"element\": \"file\"\r\n }\r\n ],\r\n \"extended\": \"\",\r\n \"meta\": \"\",\r\n \"origin\": \"\",\r\n \"time\": \"2026-08-06 10:31:30\"\r\n}" }, { "name": "Internal Server Error", "originalRequest": { "method": "PUT", "header": [ { "key": "Client-Key", "value": "{{clientKey}}", "description": "(Required) Your unique client key." }, { "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}", "description": "(Required) Your unique subscription key." }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"description\": \"Employee breakfast\",\n \"verificationSeries\": \"A\",\n \"receiptDate\": \"2020-05-04\",\n \"accounts\": [\n {\n \"account\": \"1930\",\n \"periodicity\": {\n \"offsetAccount\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\"\n },\n \"project\": {\n \"targetValue\": \"\"\n },\n \"costBearer\": {\n \"targetValue\": \"\"\n },\n \"resultsCentre\": {\n \"targetValue\": \"\"\n },\n \"debit\": \"0,00\",\n \"credit\": \"3119,00\"\n },\n {\n \"account\": \"2641\",\n \"periodicity\": {\n \"offsetAccount\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\"\n },\n \"project\": {\n \"targetValue\": \"\"\n },\n \"costBearer\": {\n \"targetValue\": \"\"\n },\n \"resultsCentre\": {\n \"targetValue\": \"\"\n },\n \"debit\": \"623,82\",\n \"credit\": \"0,00\"\n },\n {\n \"account\": \"1790\",\n \"periodicity\": {\n \"offsetAccount\": \"6210\",\n \"startDate\": \"2020-05-01\",\n \"endDate\": \"2021-04-30\"\n },\n \"project\": {\n \"targetValue\": \"P657588\"\n },\n \"costBearer\": {\n \"targetValue\": \"10\"\n },\n \"resultsCentre\": {\n \"targetValue\": \"20\"\n },\n \"debit\": \"2495,29\",\n \"credit\": \"0,00\"\n },\n {\n \"account\": \"3740\",\n \"periodicity\": {\n \"offsetAccount\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\"\n },\n \"project\": {\n \"targetValue\": \"\"\n },\n \"costBearer\": {\n \"targetValue\": \"\"\n },\n \"resultsCentre\": {\n \"targetValue\": \"\"\n },\n \"debit\": \"0,00\",\n \"credit\": \"0,11\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/companies/:companyID/files/:fileID/receipts", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "files", ":fileID", "receipts" ], "variable": [ { "key": "companyID" }, { "key": "fileID" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\r\n \"success\": false,\r\n \"data\": [\r\n {\r\n \"code\": 1009220,\r\n \"message\": \"Database operation failed.\",\r\n \"details\": \"\",\r\n \"element\": \"\"\r\n }\r\n ],\r\n \"extended\": \"\",\r\n \"meta\": \"\",\r\n \"origin\": \"\",\r\n \"time\": \"2026-08-06 10:32:00\"\r\n}" } ] } ] }, { "name": "Customers", "item": [ { "name": "Add a customer", "request": { "method": "POST", "header": [ { "key": "Client-Key", "value": "{{clientKey}}", "description": "(Required) Your unique client key." }, { "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}", "description": "(Required) Your unique subscription key." }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/companies/:companyID/customers", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "customers" ], "query": [], "variable": [ { "key": "companyID", "value": "1", "description": "(Required) The company's unique ID." } ] }, "description": "Add a customer.", "body": { "mode": "raw", "raw": "{\r\n \"customerID\": \"1\",\r\n \"customerName\": \"Telavox\",\r\n \"legalRegistrationNumber\": \"556600-7786\",\r\n \"vatNumber\": \"SE556600778601\",\r\n \"countryOfOrigin\": \"SE\",\r\n \"customerTags\": {\r\n \"customerTag1\": \"billing@telavox.se\",\r\n \"customerTag2\": \"+46712345678\",\r\n \"customerTag3\": \"\",\r\n \"customerTag4\": \"\",\r\n \"customerTag5\": \"\",\r\n \"customerTag6\": \"\"\r\n }\r\n}" } }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "key": "Client-Key", "value": "{{clientKey}}", "description": "(Required) Your unique client key." }, { "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}", "description": "(Required) Your unique subscription key." }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/companies/:companyID/customers", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "customers" ], "query": [], "variable": [ { "key": "companyID", "value": "1", "description": "(Required) The company's unique ID." } ] }, "description": "Add a customer.", "body": { "mode": "raw", "raw": "{\n \"customerID\": \"1\",\n \"customerName\": \"Telavox\",\n \"legalRegistrationNumber\": \"556600-7786\",\n \"vatNumber\": \"SE556600778601\",\n \"countryOfOrigin\": \"SE\",\n \"customerTags\": {\n \"customerTag1\": \"billing@telavox.se\",\n \"customerTag2\": \"+46712345678\",\n \"customerTag3\": \"\",\n \"customerTag4\": \"\",\n \"customerTag5\": \"\",\n \"customerTag6\": \"\"\n }\n}" } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\r\n \"success\": true,\r\n \"data\": {\r\n \"customerID\": \"1\",\r\n \"customerName\": \"Telavox\",\r\n \"legalRegistrationNumber\": \"556600-7786\",\r\n \"vatNumber\": \"SE556600778601\",\r\n \"countryOfOrigin\": \"SE\",\r\n \"customerTags\": {\r\n \"customerTag1\": \"billing@telavox.se\",\r\n \"customerTag2\": \"+46712345678\",\r\n \"customerTag3\": \"\",\r\n \"customerTag4\": \"\",\r\n \"customerTag5\": \"\",\r\n \"customerTag6\": \"\"\r\n }\r\n },\r\n \"extended\": \"\",\r\n \"meta\": \"\",\r\n \"origin\": \"\",\r\n \"time\": \"2026-05-20 12:00:00\"\r\n}" }, { "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "key": "Client-Key", "value": "{{clientKey}}", "description": "(Required) Your unique client key." }, { "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}", "description": "(Required) Your unique subscription key." }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/companies/:companyID/customers", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "customers" ], "query": [], "variable": [ { "key": "companyID", "value": "1", "description": "(Required) The company's unique ID." } ] }, "description": "Add a customer.", "body": { "mode": "raw", "raw": "{\n \"customerID\": \"1\",\n \"customerName\": \"Telavox\",\n \"legalRegistrationNumber\": \"556600-7786\",\n \"vatNumber\": \"SE556600778601\",\n \"countryOfOrigin\": \"SE\",\n \"customerTags\": {\n \"customerTag1\": \"billing@telavox.se\",\n \"customerTag2\": \"+46712345678\",\n \"customerTag3\": \"\",\n \"customerTag4\": \"\",\n \"customerTag5\": \"\",\n \"customerTag6\": \"\"\n }\n}" } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\r\n \"success\": false,\r\n \"data\": [\r\n {\r\n \"code\": 621101,\r\n \"message\": \"Legal registration number, vat number and customertags are missing\",\r\n \"details\": \"\",\r\n \"element\": \"\"\r\n }\r\n ],\r\n \"extended\": \"\",\r\n \"meta\": \"\",\r\n \"origin\": \"\",\r\n \"time\": \"2026-05-20 12:00:00\"\r\n}" }, { "name": "Not Found", "originalRequest": { "method": "POST", "header": [ { "key": "Client-Key", "value": "{{clientKey}}", "description": "(Required) Your unique client key." }, { "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}", "description": "(Required) Your unique subscription key." }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/companies/:companyID/customers", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "customers" ], "query": [], "variable": [ { "key": "companyID", "value": "1", "description": "(Required) The company's unique ID." } ] }, "description": "Add a customer.", "body": { "mode": "raw", "raw": "{\n \"customerID\": \"1\",\n \"customerName\": \"Telavox\",\n \"legalRegistrationNumber\": \"556600-7786\",\n \"vatNumber\": \"SE556600778601\",\n \"countryOfOrigin\": \"SE\",\n \"customerTags\": {\n \"customerTag1\": \"billing@telavox.se\",\n \"customerTag2\": \"+46712345678\",\n \"customerTag3\": \"\",\n \"customerTag4\": \"\",\n \"customerTag5\": \"\",\n \"customerTag6\": \"\"\n }\n}" } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\r\n \"success\": false,\r\n \"data\": [\r\n {\r\n \"code\": 111401,\r\n \"message\": \"Company ID not found.\",\r\n \"details\": \"\",\r\n \"element\": \"companyID\"\r\n }\r\n ],\r\n \"extended\": \"\",\r\n \"meta\": \"\",\r\n \"origin\": \"\",\r\n \"time\": \"2026-05-20 12:00:00\"\r\n}" }, { "name": "Internal Server Error", "originalRequest": { "method": "POST", "header": [ { "key": "Client-Key", "value": "{{clientKey}}", "description": "(Required) Your unique client key." }, { "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}", "description": "(Required) Your unique subscription key." }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/companies/:companyID/customers", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "customers" ], "query": [], "variable": [ { "key": "companyID", "value": "1", "description": "(Required) The company's unique ID." } ] }, "description": "Add a customer.", "body": { "mode": "raw", "raw": "{\n \"customerID\": \"1\",\n \"customerName\": \"Telavox\",\n \"legalRegistrationNumber\": \"556600-7786\",\n \"vatNumber\": \"SE556600778601\",\n \"countryOfOrigin\": \"SE\",\n \"customerTags\": {\n \"customerTag1\": \"billing@telavox.se\",\n \"customerTag2\": \"+46712345678\",\n \"customerTag3\": \"\",\n \"customerTag4\": \"\",\n \"customerTag5\": \"\",\n \"customerTag6\": \"\"\n }\n}" } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\r\n \"success\": false,\r\n \"data\": [\r\n {\r\n \"code\": 1009220,\r\n \"message\": \"Database operation failed.\",\r\n \"details\": \"\",\r\n \"element\": \"\"\r\n }\r\n ],\r\n \"extended\": \"\",\r\n \"meta\": \"\",\r\n \"origin\": \"\",\r\n \"time\": \"2026-05-20 12:00:00\"\r\n}" } ] }, { "name": "Add a customer list", "request": { "method": "POST", "header": [ { "key": "Client-Key", "value": "{{clientKey}}", "description": "(Required) Your unique client key." }, { "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}", "description": "(Required) Your unique subscription key." }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/companies/:companyID/customers/multiple", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "customers", "multiple" ], "query": [], "variable": [ { "key": "companyID", "value": "1", "description": "(Required) The company's unique ID." } ] }, "description": "Add a customer list.", "body": { "mode": "raw", "raw": "{\r\n \"customers\": [\r\n {\r\n \"customerID\": \"1\",\r\n \"customerName\": \"Telavox\",\r\n \"legalRegistrationNumber\": \"556600-7786\",\r\n \"vatNumber\": \"SE556600778601\",\r\n \"countryOfOrigin\": \"SE\",\r\n \"customerTags\": {\r\n \"customerTag1\": \"billing@telavox.se\",\r\n \"customerTag2\": \"+46712345678\",\r\n \"customerTag3\": \"\",\r\n \"customerTag4\": \"\",\r\n \"customerTag5\": \"\",\r\n \"customerTag6\": \"\"\r\n }\r\n },\r\n {\r\n \"customerID\": \"2\",\r\n \"customerName\": \"Acme Consulting\",\r\n \"legalRegistrationNumber\": \"19800101-1234\",\r\n \"vatNumber\": \"\",\r\n \"countryOfOrigin\": \"SE\",\r\n \"customerTags\": {\r\n \"customerTag1\": \"accounts@acme.example\",\r\n \"customerTag2\": \"Box 123, 11122 Stockholm\",\r\n \"customerTag3\": \"\",\r\n \"customerTag4\": \"\",\r\n \"customerTag5\": \"\",\r\n \"customerTag6\": \"\"\r\n }\r\n }\r\n ]\r\n}" } }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "key": "Client-Key", "value": "{{clientKey}}", "description": "(Required) Your unique client key." }, { "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}", "description": "(Required) Your unique subscription key." }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/companies/:companyID/customers/multiple", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "customers", "multiple" ], "query": [], "variable": [ { "key": "companyID", "value": "1", "description": "(Required) The company's unique ID." } ] }, "description": "Add a customer list.", "body": { "mode": "raw", "raw": "{\n \"customers\": [\n {\n \"customerID\": \"1\",\n \"customerName\": \"Telavox\",\n \"legalRegistrationNumber\": \"556600-7786\",\n \"vatNumber\": \"SE556600778601\",\n \"countryOfOrigin\": \"SE\",\n \"customerTags\": {\n \"customerTag1\": \"billing@telavox.se\",\n \"customerTag2\": \"+46712345678\",\n \"customerTag3\": \"\",\n \"customerTag4\": \"\",\n \"customerTag5\": \"\",\n \"customerTag6\": \"\"\n }\n },\n {\n \"customerID\": \"2\",\n \"customerName\": \"Acme Consulting\",\n \"legalRegistrationNumber\": \"19800101-1234\",\n \"vatNumber\": \"\",\n \"countryOfOrigin\": \"SE\",\n \"customerTags\": {\n \"customerTag1\": \"accounts@acme.example\",\n \"customerTag2\": \"Box 123, 11122 Stockholm\",\n \"customerTag3\": \"\",\n \"customerTag4\": \"\",\n \"customerTag5\": \"\",\n \"customerTag6\": \"\"\n }\n }\n ]\n}" } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\r\n \"objectList\": [\r\n {\r\n \"success\": true,\r\n \"data\": {\r\n \"customerID\": \"1\",\r\n \"customerName\": \"Telavox\",\r\n \"legalRegistrationNumber\": \"556600-7786\",\r\n \"vatNumber\": \"SE556600778601\",\r\n \"countryOfOrigin\": \"SE\",\r\n \"customerTags\": {\r\n \"customerTag1\": \"billing@telavox.se\",\r\n \"customerTag2\": \"+46712345678\",\r\n \"customerTag3\": \"\",\r\n \"customerTag4\": \"\",\r\n \"customerTag5\": \"\",\r\n \"customerTag6\": \"\"\r\n }\r\n },\r\n \"objectID\": \"1\"\r\n },\r\n {\r\n \"success\": true,\r\n \"data\": {\r\n \"customerID\": \"2\",\r\n \"customerName\": \"Acme Consulting\",\r\n \"legalRegistrationNumber\": \"19800101-1234\",\r\n \"vatNumber\": \"\",\r\n \"countryOfOrigin\": \"SE\",\r\n \"customerTags\": {\r\n \"customerTag1\": \"accounts@acme.example\",\r\n \"customerTag2\": \"Box 123, 11122 Stockholm\",\r\n \"customerTag3\": \"\",\r\n \"customerTag4\": \"\",\r\n \"customerTag5\": \"\",\r\n \"customerTag6\": \"\"\r\n }\r\n },\r\n \"objectID\": \"2\"\r\n }\r\n ],\r\n \"time\": \"2026-05-18 20:18:34\"\r\n}" }, { "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "key": "Client-Key", "value": "{{clientKey}}", "description": "(Required) Your unique client key." }, { "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}", "description": "(Required) Your unique subscription key." }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/companies/:companyID/customers/multiple", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "customers", "multiple" ], "query": [], "variable": [ { "key": "companyID", "value": "1", "description": "(Required) The company's unique ID." } ] }, "description": "Add a customer list.", "body": { "mode": "raw", "raw": "{\n \"customers\": [\n {\n \"customerID\": \"1\",\n \"customerName\": \"Telavox\",\n \"legalRegistrationNumber\": \"556600-7786\",\n \"vatNumber\": \"SE556600778601\",\n \"countryOfOrigin\": \"SE\",\n \"customerTags\": {\n \"customerTag1\": \"billing@telavox.se\",\n \"customerTag2\": \"+46712345678\",\n \"customerTag3\": \"\",\n \"customerTag4\": \"\",\n \"customerTag5\": \"\",\n \"customerTag6\": \"\"\n }\n },\n {\n \"customerID\": \"2\",\n \"customerName\": \"Acme Consulting\",\n \"legalRegistrationNumber\": \"19800101-1234\",\n \"vatNumber\": \"\",\n \"countryOfOrigin\": \"SE\",\n \"customerTags\": {\n \"customerTag1\": \"accounts@acme.example\",\n \"customerTag2\": \"Box 123, 11122 Stockholm\",\n \"customerTag3\": \"\",\n \"customerTag4\": \"\",\n \"customerTag5\": \"\",\n \"customerTag6\": \"\"\n }\n }\n ]\n}" } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\r\n \"success\": false,\r\n \"data\": [\r\n {\r\n \"code\": 111402,\r\n \"message\": \"Company ID is not valid.\",\r\n \"details\": \"\",\r\n \"element\": \"companyID\"\r\n }\r\n ],\r\n \"extended\": \"\",\r\n \"meta\": \"\",\r\n \"origin\": \"\",\r\n \"time\": \"2026-05-20 12:00:00\"\r\n}" }, { "name": "Not Found", "originalRequest": { "method": "POST", "header": [ { "key": "Client-Key", "value": "{{clientKey}}", "description": "(Required) Your unique client key." }, { "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}", "description": "(Required) Your unique subscription key." }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/companies/:companyID/customers/multiple", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "customers", "multiple" ], "query": [], "variable": [ { "key": "companyID", "value": "1", "description": "(Required) The company's unique ID." } ] }, "description": "Add a customer list.", "body": { "mode": "raw", "raw": "{\n \"customers\": [\n {\n \"customerID\": \"1\",\n \"customerName\": \"Telavox\",\n \"legalRegistrationNumber\": \"556600-7786\",\n \"vatNumber\": \"SE556600778601\",\n \"countryOfOrigin\": \"SE\",\n \"customerTags\": {\n \"customerTag1\": \"billing@telavox.se\",\n \"customerTag2\": \"+46712345678\",\n \"customerTag3\": \"\",\n \"customerTag4\": \"\",\n \"customerTag5\": \"\",\n \"customerTag6\": \"\"\n }\n },\n {\n \"customerID\": \"2\",\n \"customerName\": \"Acme Consulting\",\n \"legalRegistrationNumber\": \"19800101-1234\",\n \"vatNumber\": \"\",\n \"countryOfOrigin\": \"SE\",\n \"customerTags\": {\n \"customerTag1\": \"accounts@acme.example\",\n \"customerTag2\": \"Box 123, 11122 Stockholm\",\n \"customerTag3\": \"\",\n \"customerTag4\": \"\",\n \"customerTag5\": \"\",\n \"customerTag6\": \"\"\n }\n }\n ]\n}" } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\r\n \"success\": false,\r\n \"data\": [\r\n {\r\n \"code\": 111401,\r\n \"message\": \"Company ID not found.\",\r\n \"details\": \"\",\r\n \"element\": \"companyID\"\r\n }\r\n ],\r\n \"extended\": \"\",\r\n \"meta\": \"\",\r\n \"origin\": \"\",\r\n \"time\": \"2026-05-20 12:00:00\"\r\n}" }, { "name": "Conflict", "originalRequest": { "method": "POST", "header": [ { "key": "Client-Key", "value": "{{clientKey}}", "description": "(Required) Your unique client key." }, { "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}", "description": "(Required) Your unique subscription key." }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/companies/:companyID/customers/multiple", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "customers", "multiple" ], "query": [], "variable": [ { "key": "companyID", "value": "1", "description": "(Required) The company's unique ID." } ] }, "description": "Add a customer list.", "body": { "mode": "raw", "raw": "{\n \"customers\": [\n {\n \"customerID\": \"1\",\n \"customerName\": \"Telavox\",\n \"legalRegistrationNumber\": \"556600-7786\",\n \"vatNumber\": \"SE556600778601\",\n \"countryOfOrigin\": \"SE\",\n \"customerTags\": {\n \"customerTag1\": \"billing@telavox.se\",\n \"customerTag2\": \"+46712345678\",\n \"customerTag3\": \"\",\n \"customerTag4\": \"\",\n \"customerTag5\": \"\",\n \"customerTag6\": \"\"\n }\n },\n {\n \"customerID\": \"2\",\n \"customerName\": \"Acme Consulting\",\n \"legalRegistrationNumber\": \"19800101-1234\",\n \"vatNumber\": \"\",\n \"countryOfOrigin\": \"SE\",\n \"customerTags\": {\n \"customerTag1\": \"accounts@acme.example\",\n \"customerTag2\": \"Box 123, 11122 Stockholm\",\n \"customerTag3\": \"\",\n \"customerTag4\": \"\",\n \"customerTag5\": \"\",\n \"customerTag6\": \"\"\n }\n }\n ]\n}" } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\r\n \"objectList\": [\r\n {\r\n \"success\": false,\r\n \"data\": [\r\n {\r\n \"code\": 621101,\r\n \"message\": \"Legal registration number, vat number and customertags are missing\",\r\n \"details\": \"\",\r\n \"element\": \"\"\r\n }\r\n ],\r\n \"objectID\": \"1\"\r\n },\r\n {\r\n \"success\": true,\r\n \"data\": {\r\n \"customerID\": \"2\",\r\n \"customerName\": \"Acme Consulting\",\r\n \"legalRegistrationNumber\": \"19800101-1234\",\r\n \"vatNumber\": \"\",\r\n \"countryOfOrigin\": \"SE\",\r\n \"customerTags\": {\r\n \"customerTag1\": \"accounts@acme.example\",\r\n \"customerTag2\": \"Box 123, 11122 Stockholm\",\r\n \"customerTag3\": \"\",\r\n \"customerTag4\": \"\",\r\n \"customerTag5\": \"\",\r\n \"customerTag6\": \"\"\r\n }\r\n },\r\n \"objectID\": \"2\"\r\n }\r\n ],\r\n \"time\": \"2026-05-18 20:18:34\"\r\n}" }, { "name": "Internal Server Error", "originalRequest": { "method": "POST", "header": [ { "key": "Client-Key", "value": "{{clientKey}}", "description": "(Required) Your unique client key." }, { "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}", "description": "(Required) Your unique subscription key." }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/companies/:companyID/customers/multiple", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "customers", "multiple" ], "query": [], "variable": [ { "key": "companyID", "value": "1", "description": "(Required) The company's unique ID." } ] }, "description": "Add a customer list.", "body": { "mode": "raw", "raw": "{\n \"customers\": [\n {\n \"customerID\": \"1\",\n \"customerName\": \"Telavox\",\n \"legalRegistrationNumber\": \"556600-7786\",\n \"vatNumber\": \"SE556600778601\",\n \"countryOfOrigin\": \"SE\",\n \"customerTags\": {\n \"customerTag1\": \"billing@telavox.se\",\n \"customerTag2\": \"+46712345678\",\n \"customerTag3\": \"\",\n \"customerTag4\": \"\",\n \"customerTag5\": \"\",\n \"customerTag6\": \"\"\n }\n },\n {\n \"customerID\": \"2\",\n \"customerName\": \"Acme Consulting\",\n \"legalRegistrationNumber\": \"19800101-1234\",\n \"vatNumber\": \"\",\n \"countryOfOrigin\": \"SE\",\n \"customerTags\": {\n \"customerTag1\": \"accounts@acme.example\",\n \"customerTag2\": \"Box 123, 11122 Stockholm\",\n \"customerTag3\": \"\",\n \"customerTag4\": \"\",\n \"customerTag5\": \"\",\n \"customerTag6\": \"\"\n }\n }\n ]\n}" } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\r\n \"success\": false,\r\n \"data\": [\r\n {\r\n \"code\": 1009220,\r\n \"message\": \"Database operation failed.\",\r\n \"details\": \"\",\r\n \"element\": \"\"\r\n }\r\n ],\r\n \"extended\": \"\",\r\n \"meta\": \"\",\r\n \"origin\": \"\",\r\n \"time\": \"2026-05-20 12:00:00\"\r\n}" } ] }, { "name": "Retrieve all customers", "request": { "method": "GET", "header": [ { "key": "Client-Key", "value": "{{clientKey}}", "description": "(Required) Your unique client key." }, { "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}", "description": "(Required) Your unique subscription key." } ], "url": { "raw": "{{baseUrl}}/companies/:companyID/customers?pageNumber=1&pageSize=10", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "customers" ], "query": [ { "key": "pageNumber", "value": "1", "description": "The page number to retrieve." }, { "key": "pageSize", "value": "10", "description": "The number of customers per page." } ], "variable": [ { "key": "companyID", "value": "1", "description": "(Required) The company's unique ID." } ] }, "description": "Retrieve all customers." }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Client-Key", "value": "{{clientKey}}", "description": "(Required) Your unique client key." }, { "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}", "description": "(Required) Your unique subscription key." } ], "url": { "raw": "{{baseUrl}}/companies/:companyID/customers?pageNumber=1&pageSize=10", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "customers" ], "query": [ { "key": "pageNumber", "value": "1", "description": "The page number to retrieve." }, { "key": "pageSize", "value": "10", "description": "The number of customers per page." } ], "variable": [ { "key": "companyID", "value": "1", "description": "(Required) The company's unique ID." } ] }, "description": "Retrieve all customers." }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\r\n \"success\": true,\r\n \"data\": {\r\n \"customers\": [\r\n {\r\n \"customerID\": \"1\",\r\n \"customerName\": \"Telavox\",\r\n \"legalRegistrationNumber\": \"556600-7786\",\r\n \"vatNumber\": \"SE556600778601\",\r\n \"countryOfOrigin\": \"SE\",\r\n \"customerTags\": {\r\n \"customerTag1\": \"billing@telavox.se\",\r\n \"customerTag2\": \"+46712345678\",\r\n \"customerTag3\": \"\",\r\n \"customerTag4\": \"\",\r\n \"customerTag5\": \"\",\r\n \"customerTag6\": \"\"\r\n }\r\n },\r\n {\r\n \"customerID\": \"2\",\r\n \"customerName\": \"Acme Consulting\",\r\n \"legalRegistrationNumber\": \"19800101-1234\",\r\n \"vatNumber\": \"\",\r\n \"countryOfOrigin\": \"SE\",\r\n \"customerTags\": {\r\n \"customerTag1\": \"accounts@acme.example\",\r\n \"customerTag2\": \"Box 123, 11122 Stockholm\",\r\n \"customerTag3\": \"\",\r\n \"customerTag4\": \"\",\r\n \"customerTag5\": \"\",\r\n \"customerTag6\": \"\"\r\n }\r\n }\r\n ]\r\n },\r\n \"extended\": \"\",\r\n \"meta\": {\r\n \"pagination\": {\r\n \"pageNumber\": 1,\r\n \"pageSize\": 10,\r\n \"totalItems\": 2,\r\n \"totalPages\": 1\r\n }\r\n },\r\n \"origin\": \"\",\r\n \"time\": \"2026-08-06 09:30:00\"\r\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "key": "Client-Key", "value": "{{clientKey}}", "description": "(Required) Your unique client key." }, { "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}", "description": "(Required) Your unique subscription key." } ], "url": { "raw": "{{baseUrl}}/companies/:companyID/customers?pageNumber=1&pageSize=10", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "customers" ], "query": [ { "key": "pageNumber", "value": "1", "description": "The page number to retrieve." }, { "key": "pageSize", "value": "10", "description": "The number of customers per page." } ], "variable": [ { "key": "companyID", "value": "1", "description": "(Required) The company's unique ID." } ] }, "description": "Retrieve all customers." }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\r\n \"success\": false,\r\n \"data\": [\r\n {\r\n \"code\": 101152,\r\n \"message\": \"Query parameter is not valid\",\r\n \"details\": \"Max allowed value is 100.\",\r\n \"element\": \"pageSize\"\r\n }\r\n ],\r\n \"extended\": \"\",\r\n \"meta\": \"\",\r\n \"origin\": \"\",\r\n \"time\": \"2026-08-06 09:31:00\"\r\n}" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "key": "Client-Key", "value": "{{clientKey}}", "description": "(Required) Your unique client key." }, { "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}", "description": "(Required) Your unique subscription key." } ], "url": { "raw": "{{baseUrl}}/companies/:companyID/customers?pageNumber=1&pageSize=10", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "customers" ], "query": [ { "key": "pageNumber", "value": "1", "description": "The page number to retrieve." }, { "key": "pageSize", "value": "10", "description": "The number of customers per page." } ], "variable": [ { "key": "companyID", "value": "1", "description": "(Required) The company's unique ID." } ] }, "description": "Retrieve all customers." }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\r\n \"success\": false,\r\n \"data\": [\r\n {\r\n \"code\": 111401,\r\n \"message\": \"Company ID not found.\",\r\n \"details\": \"\",\r\n \"element\": \"companyID\"\r\n }\r\n ],\r\n \"extended\": \"\",\r\n \"meta\": \"\",\r\n \"origin\": \"\",\r\n \"time\": \"2026-08-06 09:31:30\"\r\n}" }, { "name": "Internal Server Error", "originalRequest": { "method": "GET", "header": [ { "key": "Client-Key", "value": "{{clientKey}}", "description": "(Required) Your unique client key." }, { "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}", "description": "(Required) Your unique subscription key." } ], "url": { "raw": "{{baseUrl}}/companies/:companyID/customers?pageNumber=1&pageSize=10", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "customers" ], "query": [ { "key": "pageNumber", "value": "1", "description": "The page number to retrieve." }, { "key": "pageSize", "value": "10", "description": "The number of customers per page." } ], "variable": [ { "key": "companyID", "value": "1", "description": "(Required) The company's unique ID." } ] }, "description": "Retrieve all customers." }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\r\n \"success\": false,\r\n \"data\": [\r\n {\r\n \"code\": 1009220,\r\n \"message\": \"Database operation failed.\",\r\n \"details\": \"\",\r\n \"element\": \"\"\r\n }\r\n ],\r\n \"extended\": \"\",\r\n \"meta\": \"\",\r\n \"origin\": \"\",\r\n \"time\": \"2026-08-06 09:32:00\"\r\n}" } ] }, { "name": "Retrieve a customer", "request": { "method": "GET", "header": [ { "key": "Client-Key", "value": "{{clientKey}}", "description": "(Required) Your unique client key." }, { "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}", "description": "(Required) Your unique subscription key." } ], "url": { "raw": "{{baseUrl}}/companies/:companyID/customers/:customerID", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "customers", ":customerID" ], "query": [], "variable": [ { "key": "companyID", "value": "1", "description": "(Required) The company's unique ID." }, { "key": "customerID", "value": "1", "description": "(Required) The customer's unique ID." } ] }, "description": "Retrieve a customer." }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Client-Key", "value": "{{clientKey}}", "description": "(Required) Your unique client key." }, { "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}", "description": "(Required) Your unique subscription key." } ], "url": { "raw": "{{baseUrl}}/companies/:companyID/customers/:customerID", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "customers", ":customerID" ], "query": [], "variable": [ { "key": "companyID", "value": "1", "description": "(Required) The company's unique ID." }, { "key": "customerID", "value": "1", "description": "(Required) The customer's unique ID." } ] }, "description": "Retrieve a customer." }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\r\n \"success\": true,\r\n \"data\": {\r\n \"customerID\": \"1\",\r\n \"customerName\": \"Telavox\",\r\n \"legalRegistrationNumber\": \"556600-7786\",\r\n \"vatNumber\": \"SE556600778601\",\r\n \"countryOfOrigin\": \"SE\",\r\n \"customerTags\": {\r\n \"customerTag1\": \"billing@telavox.se\",\r\n \"customerTag2\": \"+46712345678\",\r\n \"customerTag3\": \"\",\r\n \"customerTag4\": \"\",\r\n \"customerTag5\": \"\",\r\n \"customerTag6\": \"\"\r\n }\r\n },\r\n \"extended\": \"\",\r\n \"meta\": \"\",\r\n \"origin\": \"\",\r\n \"time\": \"2026-08-06 09:22:35\"\r\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "key": "Client-Key", "value": "{{clientKey}}", "description": "(Required) Your unique client key." }, { "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}", "description": "(Required) Your unique subscription key." } ], "url": { "raw": "{{baseUrl}}/companies/:companyID/customers/:customerID", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "customers", ":customerID" ], "query": [], "variable": [ { "key": "companyID", "value": "1", "description": "(Required) The company's unique ID." }, { "key": "customerID", "value": "1", "description": "(Required) The customer's unique ID." } ] }, "description": "Retrieve a customer." }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\r\n \"success\": false,\r\n \"data\": [\r\n {\r\n \"code\": 621402,\r\n \"message\": \"Customer ID is not valid.\",\r\n \"details\": \"\",\r\n \"element\": \"customerID\"\r\n }\r\n ],\r\n \"extended\": \"\",\r\n \"meta\": \"\",\r\n \"origin\": \"\",\r\n \"time\": \"2026-08-06 09:23:10\"\r\n}" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "key": "Client-Key", "value": "{{clientKey}}", "description": "(Required) Your unique client key." }, { "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}", "description": "(Required) Your unique subscription key." } ], "url": { "raw": "{{baseUrl}}/companies/:companyID/customers/:customerID", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "customers", ":customerID" ], "query": [], "variable": [ { "key": "companyID", "value": "1", "description": "(Required) The company's unique ID." }, { "key": "customerID", "value": "1", "description": "(Required) The customer's unique ID." } ] }, "description": "Retrieve a customer." }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\r\n \"success\": false,\r\n \"data\": [\r\n {\r\n \"code\": 621401,\r\n \"message\": \"Customer ID not found.\",\r\n \"details\": \"\",\r\n \"element\": \"customerID\"\r\n }\r\n ],\r\n \"extended\": \"\",\r\n \"meta\": \"\",\r\n \"origin\": \"\",\r\n \"time\": \"2026-08-06 09:23:44\"\r\n}" }, { "name": "Internal Server Error", "originalRequest": { "method": "GET", "header": [ { "key": "Client-Key", "value": "{{clientKey}}", "description": "(Required) Your unique client key." }, { "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}", "description": "(Required) Your unique subscription key." } ], "url": { "raw": "{{baseUrl}}/companies/:companyID/customers/:customerID", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "customers", ":customerID" ], "query": [], "variable": [ { "key": "companyID", "value": "1", "description": "(Required) The company's unique ID." }, { "key": "customerID", "value": "1", "description": "(Required) The customer's unique ID." } ] }, "description": "Retrieve a customer." }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\r\n \"success\": false,\r\n \"data\": [\r\n {\r\n \"code\": 1009220,\r\n \"message\": \"Database operation failed.\",\r\n \"details\": \"\",\r\n \"element\": \"\"\r\n }\r\n ],\r\n \"extended\": \"\",\r\n \"meta\": \"\",\r\n \"origin\": \"\",\r\n \"time\": \"2026-08-06 09:24:02\"\r\n}" } ] }, { "name": "Update a customer", "request": { "method": "PUT", "header": [ { "key": "Client-Key", "value": "{{clientKey}}", "description": "(Required) Your unique client key." }, { "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}", "description": "(Required) Your unique subscription key." }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/companies/:companyID/customers/:customerID", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "customers", ":customerID" ], "query": [], "variable": [ { "key": "companyID", "value": "1", "description": "(Required) The company's unique ID." }, { "key": "customerID", "value": "1", "description": "(Required) The customer's unique ID." } ] }, "description": "Update a customer.", "body": { "mode": "raw", "raw": "{\r\n \"customerID\": \"1\",\r\n \"customerName\": \"Telavox\",\r\n \"legalRegistrationNumber\": \"556600-7786\",\r\n \"vatNumber\": \"SE556600778601\",\r\n \"countryOfOrigin\": \"SE\",\r\n \"customerTags\": {\r\n \"customerTag1\": \"billing@telavox.se\",\r\n \"customerTag2\": \"+46712345678\",\r\n \"customerTag3\": \"\",\r\n \"customerTag4\": \"\",\r\n \"customerTag5\": \"\",\r\n \"customerTag6\": \"\"\r\n }\r\n}" } }, "response": [ { "name": "OK", "originalRequest": { "method": "PUT", "header": [ { "key": "Client-Key", "value": "{{clientKey}}", "description": "(Required) Your unique client key." }, { "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}", "description": "(Required) Your unique subscription key." }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/companies/:companyID/customers/:customerID", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "customers", ":customerID" ], "query": [], "variable": [ { "key": "companyID", "value": "1", "description": "(Required) The company's unique ID." }, { "key": "customerID", "value": "1", "description": "(Required) The customer's unique ID." } ] }, "description": "Update a customer.", "body": { "mode": "raw", "raw": "{\n \"customerID\": \"1\",\n \"customerName\": \"Telavox\",\n \"legalRegistrationNumber\": \"556600-7786\",\n \"vatNumber\": \"SE556600778601\",\n \"countryOfOrigin\": \"SE\",\n \"customerTags\": {\n \"customerTag1\": \"billing@telavox.se\",\n \"customerTag2\": \"+46712345678\",\n \"customerTag3\": \"\",\n \"customerTag4\": \"\",\n \"customerTag5\": \"\",\n \"customerTag6\": \"\"\n }\n}" } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\r\n \"success\": true,\r\n \"data\": {\r\n \"customerID\": \"1\",\r\n \"customerName\": \"Telavox\",\r\n \"legalRegistrationNumber\": \"556600-7786\",\r\n \"vatNumber\": \"SE556600778601\",\r\n \"countryOfOrigin\": \"SE\",\r\n \"customerTags\": {\r\n \"customerTag1\": \"billing@telavox.se\",\r\n \"customerTag2\": \"+46712345678\",\r\n \"customerTag3\": \"\",\r\n \"customerTag4\": \"\",\r\n \"customerTag5\": \"\",\r\n \"customerTag6\": \"\"\r\n }\r\n },\r\n \"extended\": \"\",\r\n \"meta\": \"\",\r\n \"origin\": \"\",\r\n \"time\": \"2026-08-06 09:40:00\"\r\n}" }, { "name": "Bad Request", "originalRequest": { "method": "PUT", "header": [ { "key": "Client-Key", "value": "{{clientKey}}", "description": "(Required) Your unique client key." }, { "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}", "description": "(Required) Your unique subscription key." }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/companies/:companyID/customers/:customerID", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "customers", ":customerID" ], "query": [], "variable": [ { "key": "companyID", "value": "1", "description": "(Required) The company's unique ID." }, { "key": "customerID", "value": "1", "description": "(Required) The customer's unique ID." } ] }, "description": "Update a customer.", "body": { "mode": "raw", "raw": "{\n \"customerID\": \"1\",\n \"customerName\": \"Telavox\",\n \"legalRegistrationNumber\": \"556600-7786\",\n \"vatNumber\": \"SE556600778601\",\n \"countryOfOrigin\": \"SE\",\n \"customerTags\": {\n \"customerTag1\": \"billing@telavox.se\",\n \"customerTag2\": \"+46712345678\",\n \"customerTag3\": \"\",\n \"customerTag4\": \"\",\n \"customerTag5\": \"\",\n \"customerTag6\": \"\"\n }\n}" } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\r\n \"success\": false,\r\n \"data\": [\r\n {\r\n \"code\": 621402,\r\n \"message\": \"Customer ID is not valid.\",\r\n \"details\": \"CustomerID parameter and CustomerID in Body mismatch.\",\r\n \"element\": \"customerID\"\r\n }\r\n ],\r\n \"extended\": \"\",\r\n \"meta\": \"\",\r\n \"origin\": \"\",\r\n \"time\": \"2026-08-06 09:40:30\"\r\n}" }, { "name": "Not Found", "originalRequest": { "method": "PUT", "header": [ { "key": "Client-Key", "value": "{{clientKey}}", "description": "(Required) Your unique client key." }, { "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}", "description": "(Required) Your unique subscription key." }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/companies/:companyID/customers/:customerID", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "customers", ":customerID" ], "query": [], "variable": [ { "key": "companyID", "value": "1", "description": "(Required) The company's unique ID." }, { "key": "customerID", "value": "1", "description": "(Required) The customer's unique ID." } ] }, "description": "Update a customer.", "body": { "mode": "raw", "raw": "{\n \"customerID\": \"1\",\n \"customerName\": \"Telavox\",\n \"legalRegistrationNumber\": \"556600-7786\",\n \"vatNumber\": \"SE556600778601\",\n \"countryOfOrigin\": \"SE\",\n \"customerTags\": {\n \"customerTag1\": \"billing@telavox.se\",\n \"customerTag2\": \"+46712345678\",\n \"customerTag3\": \"\",\n \"customerTag4\": \"\",\n \"customerTag5\": \"\",\n \"customerTag6\": \"\"\n }\n}" } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\r\n \"success\": false,\r\n \"data\": [\r\n {\r\n \"code\": 621401,\r\n \"message\": \"Customer ID not found.\",\r\n \"details\": \"\",\r\n \"element\": \"customerID\"\r\n }\r\n ],\r\n \"extended\": \"\",\r\n \"meta\": \"\",\r\n \"origin\": \"\",\r\n \"time\": \"2026-08-06 09:41:00\"\r\n}" }, { "name": "Internal Server Error", "originalRequest": { "method": "PUT", "header": [ { "key": "Client-Key", "value": "{{clientKey}}", "description": "(Required) Your unique client key." }, { "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}", "description": "(Required) Your unique subscription key." }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/companies/:companyID/customers/:customerID", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "customers", ":customerID" ], "query": [], "variable": [ { "key": "companyID", "value": "1", "description": "(Required) The company's unique ID." }, { "key": "customerID", "value": "1", "description": "(Required) The customer's unique ID." } ] }, "description": "Update a customer.", "body": { "mode": "raw", "raw": "{\n \"customerID\": \"1\",\n \"customerName\": \"Telavox\",\n \"legalRegistrationNumber\": \"556600-7786\",\n \"vatNumber\": \"SE556600778601\",\n \"countryOfOrigin\": \"SE\",\n \"customerTags\": {\n \"customerTag1\": \"billing@telavox.se\",\n \"customerTag2\": \"+46712345678\",\n \"customerTag3\": \"\",\n \"customerTag4\": \"\",\n \"customerTag5\": \"\",\n \"customerTag6\": \"\"\n }\n}" } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\r\n \"success\": false,\r\n \"data\": [\r\n {\r\n \"code\": 1009220,\r\n \"message\": \"Database operation failed.\",\r\n \"details\": \"\",\r\n \"element\": \"\"\r\n }\r\n ],\r\n \"extended\": \"\",\r\n \"meta\": \"\",\r\n \"origin\": \"\",\r\n \"time\": \"2026-08-06 09:41:30\"\r\n}" } ] }, { "name": "Delete a customer", "request": { "method": "DELETE", "header": [ { "key": "Client-Key", "value": "{{clientKey}}", "description": "(Required) Your unique client key." }, { "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}", "description": "(Required) Your unique subscription key." } ], "url": { "raw": "{{baseUrl}}/companies/:companyID/customers/:customerID", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "customers", ":customerID" ], "query": [], "variable": [ { "key": "companyID", "value": "1", "description": "(Required) The company's unique ID." }, { "key": "customerID", "value": "1", "description": "(Required) The customer's unique ID." } ] }, "description": "Delete a customer." }, "response": [ { "name": "OK", "originalRequest": { "method": "DELETE", "header": [ { "key": "Client-Key", "value": "{{clientKey}}", "description": "(Required) Your unique client key." }, { "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}", "description": "(Required) Your unique subscription key." } ], "url": { "raw": "{{baseUrl}}/companies/:companyID/customers/:customerID", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "customers", ":customerID" ], "query": [], "variable": [ { "key": "companyID", "value": "1", "description": "(Required) The company's unique ID." }, { "key": "customerID", "value": "1", "description": "(Required) The customer's unique ID." } ] }, "description": "Delete a customer." }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\r\n \"success\": true,\r\n \"data\": {},\r\n \"extended\": \"\",\r\n \"meta\": \"\",\r\n \"origin\": \"\",\r\n \"time\": \"2026-08-06 09:50:00\"\r\n}" }, { "name": "Bad Request", "originalRequest": { "method": "DELETE", "header": [ { "key": "Client-Key", "value": "{{clientKey}}", "description": "(Required) Your unique client key." }, { "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}", "description": "(Required) Your unique subscription key." } ], "url": { "raw": "{{baseUrl}}/companies/:companyID/customers/:customerID", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "customers", ":customerID" ], "query": [], "variable": [ { "key": "companyID", "value": "1", "description": "(Required) The company's unique ID." }, { "key": "customerID", "value": "1", "description": "(Required) The customer's unique ID." } ] }, "description": "Delete a customer." }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\r\n \"success\": false,\r\n \"data\": [\r\n {\r\n \"code\": 621402,\r\n \"message\": \"Customer ID is not valid.\",\r\n \"details\": \"\",\r\n \"element\": \"customerID\"\r\n }\r\n ],\r\n \"extended\": \"\",\r\n \"meta\": \"\",\r\n \"origin\": \"\",\r\n \"time\": \"2026-08-06 09:50:30\"\r\n}" }, { "name": "Not Found", "originalRequest": { "method": "DELETE", "header": [ { "key": "Client-Key", "value": "{{clientKey}}", "description": "(Required) Your unique client key." }, { "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}", "description": "(Required) Your unique subscription key." } ], "url": { "raw": "{{baseUrl}}/companies/:companyID/customers/:customerID", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "customers", ":customerID" ], "query": [], "variable": [ { "key": "companyID", "value": "1", "description": "(Required) The company's unique ID." }, { "key": "customerID", "value": "1", "description": "(Required) The customer's unique ID." } ] }, "description": "Delete a customer." }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\r\n \"success\": false,\r\n \"data\": [\r\n {\r\n \"code\": 621401,\r\n \"message\": \"Customer ID not found.\",\r\n \"details\": \"\",\r\n \"element\": \"customerID\"\r\n }\r\n ],\r\n \"extended\": \"\",\r\n \"meta\": \"\",\r\n \"origin\": \"\",\r\n \"time\": \"2026-08-06 09:51:00\"\r\n}" }, { "name": "Internal Server Error", "originalRequest": { "method": "DELETE", "header": [ { "key": "Client-Key", "value": "{{clientKey}}", "description": "(Required) Your unique client key." }, { "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}", "description": "(Required) Your unique subscription key." } ], "url": { "raw": "{{baseUrl}}/companies/:companyID/customers/:customerID", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "customers", ":customerID" ], "query": [], "variable": [ { "key": "companyID", "value": "1", "description": "(Required) The company's unique ID." }, { "key": "customerID", "value": "1", "description": "(Required) The customer's unique ID." } ] }, "description": "Delete a customer." }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\r\n \"success\": false,\r\n \"data\": [\r\n {\r\n \"code\": 1009220,\r\n \"message\": \"Database operation failed.\",\r\n \"details\": \"\",\r\n \"element\": \"\"\r\n }\r\n ],\r\n \"extended\": \"\",\r\n \"meta\": \"\",\r\n \"origin\": \"\",\r\n \"time\": \"2026-08-06 09:51:30\"\r\n}" } ] } ] }, { "name": "Customer Invoices", "item": [ { "name": "Extract data from a customer invoice", "request": { "method": "GET", "header": [ { "key": "Client-Key", "value": "{{clientKey}}", "description": "(Required) Your unique client key." }, { "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}", "description": "(Required) Your unique subscription key." } ], "url": { "raw": "{{baseUrl}}/companies/:companyID/files/:fileID/customerInvoices?verificationSeries=A&extended=true&origin=true", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "files", ":fileID", "customerInvoices" ], "query": [ { "key": "verificationSeries", "value": "A", "description": "Extract data based on a specific verification series." }, { "key": "extended", "value": "true", "description": "When set to true, extended data will be provided in the response." }, { "key": "origin", "value": "true", "description": "When set to true, origin data will be provided in the response." } ], "variable": [ { "key": "companyID", "value": "1", "description": "(Required) The company's unique ID." }, { "key": "fileID", "value": "2", "description": "(Required) The file's unique ID." } ] }, "description": "Extract data from a customer invoice." }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Client-Key", "value": "{{clientKey}}", "description": "(Required) Your unique client key." }, { "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}", "description": "(Required) Your unique subscription key." } ], "url": { "raw": "{{baseUrl}}/companies/:companyID/files/:fileID/customerInvoices?verificationSeries=A&extended=true&origin=true", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "files", ":fileID", "customerInvoices" ], "query": [ { "key": "verificationSeries", "value": "A", "description": "Extract data based on a specific verification series." }, { "key": "extended", "value": "true", "description": "When set to true, extended data will be provided in the response." }, { "key": "origin", "value": "true", "description": "When set to true, origin data will be provided in the response." } ], "variable": [ { "key": "companyID", "value": "1", "description": "(Required) The company's unique ID." }, { "key": "fileID", "value": "2", "description": "(Required) The file's unique ID." } ] }, "description": "Extract data from a customer invoice." }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\r\n \"success\": true,\r\n \"data\": {\r\n \"customerID\": \"1\",\r\n \"description\": \"Music license fee for period 2025-07-01 to 2025-12-31\",\r\n \"verificationSeries\": \"A\",\r\n \"invoiceDate\": \"2025-10-06\",\r\n \"dueDate\": \"2025-11-05\",\r\n \"invoiceNumber\": \"779191\",\r\n \"ocrNumber\": \"22880377919146\",\r\n \"referenceNumber\": \"12345\",\r\n \"orderNumber\": \"12345\",\r\n \"ourRef\": \"Accounts Receivable\",\r\n \"yourRef\": \"Jon Johansson\",\r\n \"totalSum\": \"4950,00\",\r\n \"vat\": \"280,20\",\r\n \"accounts\": [\r\n {\r\n \"account\": \"3041\",\r\n \"periodicity\": {\r\n \"offsetAccount\": \"\",\r\n \"startDate\": \"\",\r\n \"endDate\": \"\"\r\n },\r\n \"project\": {\r\n \"targetValue\": \"P657588\"\r\n },\r\n \"costBearer\": {\r\n \"targetValue\": \"10\"\r\n },\r\n \"resultsCentre\": {\r\n \"targetValue\": \"20\"\r\n },\r\n \"debit\": \"\",\r\n \"credit\": \"4669,80\"\r\n }\r\n ]\r\n },\r\n \"extended\": {\r\n \"dates\": [\r\n \"2025-10-06\",\r\n \"2025-11-05\"\r\n ],\r\n \"times\": [\r\n \"2026-08-04\"\r\n ],\r\n \"emails\": [\r\n \"billing@telavox.se\"\r\n ],\r\n \"currencies\": [\r\n \"SEK\"\r\n ],\r\n \"creditCardNumbers\": [],\r\n \"corporateIdentityNumbers\": [\r\n \"556600-7786\"\r\n ],\r\n \"ibans\": [],\r\n \"bic\": [],\r\n \"vatNumbersByCountry\": {\r\n \"SE\": [\r\n \"SE556600778601\"\r\n ]\r\n },\r\n \"corporateIdentityNumbersByCountry\": {\r\n \"SE\": [\r\n \"5566007786\"\r\n ]\r\n },\r\n \"countryOfOrigin\": \"SE\"\r\n },\r\n \"meta\": \"\",\r\n \"origin\": {\r\n \"ancestor\": {\r\n \"ancestorType\": \"None\",\r\n \"companyID\": \"23\"\r\n }\r\n },\r\n \"time\": \"2026-08-06 10:00:00\"\r\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "key": "Client-Key", "value": "{{clientKey}}", "description": "(Required) Your unique client key." }, { "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}", "description": "(Required) Your unique subscription key." } ], "url": { "raw": "{{baseUrl}}/companies/:companyID/files/:fileID/customerInvoices?verificationSeries=A&extended=true&origin=true", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "files", ":fileID", "customerInvoices" ], "query": [ { "key": "verificationSeries", "value": "A", "description": "Extract data based on a specific verification series." }, { "key": "extended", "value": "true", "description": "When set to true, extended data will be provided in the response." }, { "key": "origin", "value": "true", "description": "When set to true, origin data will be provided in the response." } ], "variable": [ { "key": "companyID", "value": "1", "description": "(Required) The company's unique ID." }, { "key": "fileID", "value": "2", "description": "(Required) The file's unique ID." } ] }, "description": "Extract data from a customer invoice." }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\r\n \"success\": false,\r\n \"data\": [\r\n {\r\n \"code\": 111402,\r\n \"message\": \"Company ID is not valid.\",\r\n \"details\": \"\",\r\n \"element\": \"companyID\"\r\n }\r\n ],\r\n \"extended\": \"\",\r\n \"meta\": \"\",\r\n \"origin\": \"\",\r\n \"time\": \"2026-08-06 10:00:30\"\r\n}" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "key": "Client-Key", "value": "{{clientKey}}", "description": "(Required) Your unique client key." }, { "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}", "description": "(Required) Your unique subscription key." } ], "url": { "raw": "{{baseUrl}}/companies/:companyID/files/:fileID/customerInvoices?verificationSeries=A&extended=true&origin=true", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "files", ":fileID", "customerInvoices" ], "query": [ { "key": "verificationSeries", "value": "A", "description": "Extract data based on a specific verification series." }, { "key": "extended", "value": "true", "description": "When set to true, extended data will be provided in the response." }, { "key": "origin", "value": "true", "description": "When set to true, origin data will be provided in the response." } ], "variable": [ { "key": "companyID", "value": "1", "description": "(Required) The company's unique ID." }, { "key": "fileID", "value": "2", "description": "(Required) The file's unique ID." } ] }, "description": "Extract data from a customer invoice." }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\r\n \"success\": false,\r\n \"data\": [\r\n {\r\n \"code\": 211401,\r\n \"message\": \"File ID not found.\",\r\n \"details\": \"\",\r\n \"element\": \"fileID\"\r\n }\r\n ],\r\n \"extended\": \"\",\r\n \"meta\": \"\",\r\n \"origin\": \"\",\r\n \"time\": \"2026-08-06 10:01:00\"\r\n}" }, { "name": "Precondition Failed", "originalRequest": { "method": "GET", "header": [ { "key": "Client-Key", "value": "{{clientKey}}", "description": "(Required) Your unique client key." }, { "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}", "description": "(Required) Your unique subscription key." } ], "url": { "raw": "{{baseUrl}}/companies/:companyID/files/:fileID/customerInvoices?verificationSeries=A&extended=true&origin=true", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "files", ":fileID", "customerInvoices" ], "query": [ { "key": "verificationSeries", "value": "A", "description": "Extract data based on a specific verification series." }, { "key": "extended", "value": "true", "description": "When set to true, extended data will be provided in the response." }, { "key": "origin", "value": "true", "description": "When set to true, origin data will be provided in the response." } ], "variable": [ { "key": "companyID", "value": "1", "description": "(Required) The company's unique ID." }, { "key": "fileID", "value": "2", "description": "(Required) The file's unique ID." } ] }, "description": "Extract data from a customer invoice." }, "status": "Precondition Failed", "code": 412, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\r\n \"success\": false,\r\n \"data\": [\r\n {\r\n \"code\": 211215,\r\n \"message\": \"File is not ready for extraction.\",\r\n \"details\": \"\",\r\n \"element\": \"file\"\r\n }\r\n ],\r\n \"extended\": \"\",\r\n \"meta\": \"\",\r\n \"origin\": \"\",\r\n \"time\": \"2026-08-06 10:01:30\"\r\n}" }, { "name": "Internal Server Error", "originalRequest": { "method": "GET", "header": [ { "key": "Client-Key", "value": "{{clientKey}}", "description": "(Required) Your unique client key." }, { "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}", "description": "(Required) Your unique subscription key." } ], "url": { "raw": "{{baseUrl}}/companies/:companyID/files/:fileID/customerInvoices?verificationSeries=A&extended=true&origin=true", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "files", ":fileID", "customerInvoices" ], "query": [ { "key": "verificationSeries", "value": "A", "description": "Extract data based on a specific verification series." }, { "key": "extended", "value": "true", "description": "When set to true, extended data will be provided in the response." }, { "key": "origin", "value": "true", "description": "When set to true, origin data will be provided in the response." } ], "variable": [ { "key": "companyID", "value": "1", "description": "(Required) The company's unique ID." }, { "key": "fileID", "value": "2", "description": "(Required) The file's unique ID." } ] }, "description": "Extract data from a customer invoice." }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\r\n \"success\": false,\r\n \"data\": [\r\n {\r\n \"code\": 1009220,\r\n \"message\": \"Database operation failed.\",\r\n \"details\": \"\",\r\n \"element\": \"\"\r\n }\r\n ],\r\n \"extended\": \"\",\r\n \"meta\": \"\",\r\n \"origin\": \"\",\r\n \"time\": \"2026-08-06 10:02:00\"\r\n}" } ] }, { "name": "Bookkeep a customer invoice", "request": { "method": "PUT", "header": [ { "key": "Client-Key", "value": "{{clientKey}}", "description": "(Required) Your unique client key." }, { "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}", "description": "(Required) Your unique subscription key." }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/companies/:companyID/files/:fileID/customerInvoices", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "files", ":fileID", "customerInvoices" ], "query": [], "variable": [ { "key": "companyID", "value": "1", "description": "(Required) The company's unique ID." }, { "key": "fileID", "value": "2", "description": "(Required) The file's unique ID." } ] }, "description": "Bookkeep a customer invoice.", "body": { "mode": "raw", "raw": "{\r\n \"customerID\": \"1\",\r\n \"description\": \"Music license fee for period 2025-07-01 to 2025-12-31\",\r\n \"verificationSeries\": \"A\",\r\n \"invoiceDate\": \"2025-10-06\",\r\n \"dueDate\": \"2025-11-05\",\r\n \"invoiceNumber\": \"779191\",\r\n \"ocrNumber\": \"22880377919146\",\r\n \"referenceNumber\": \"12345\",\r\n \"orderNumber\": \"12345\",\r\n \"ourRef\": \"Accounts Receivable\",\r\n \"yourRef\": \"Jon Johansson\",\r\n \"totalSum\": \"4950,00\",\r\n \"vat\": \"990,00\",\r\n \"accounts\": [\r\n {\r\n \"account\": \"3041\",\r\n \"periodicity\": {\r\n \"offsetAccount\": \"\",\r\n \"startDate\": \"\",\r\n \"endDate\": \"\"\r\n },\r\n \"project\": {\r\n \"targetValue\": \"P657588\"\r\n },\r\n \"costBearer\": {\r\n \"targetValue\": \"10\"\r\n },\r\n \"resultsCentre\": {\r\n \"targetValue\": \"20\"\r\n },\r\n \"debit\": \"\",\r\n \"credit\": \"3960,00\"\r\n }\r\n ]\r\n}" } }, "response": [ { "name": "OK", "originalRequest": { "method": "PUT", "header": [ { "key": "Client-Key", "value": "{{clientKey}}", "description": "(Required) Your unique client key." }, { "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}", "description": "(Required) Your unique subscription key." }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/companies/:companyID/files/:fileID/customerInvoices", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "files", ":fileID", "customerInvoices" ], "query": [], "variable": [ { "key": "companyID", "value": "1", "description": "(Required) The company's unique ID." }, { "key": "fileID", "value": "2", "description": "(Required) The file's unique ID." } ] }, "description": "Bookkeep a customer invoice.", "body": { "mode": "raw", "raw": "{\n \"customerID\": \"1\",\n \"description\": \"Music license fee for period 2025-07-01 to 2025-12-31\",\n \"verificationSeries\": \"A\",\n \"invoiceDate\": \"2025-10-06\",\n \"dueDate\": \"2025-11-05\",\n \"invoiceNumber\": \"779191\",\n \"ocrNumber\": \"22880377919146\",\n \"referenceNumber\": \"12345\",\n \"orderNumber\": \"12345\",\n \"ourRef\": \"Accounts Receivable\",\n \"yourRef\": \"Jon Johansson\",\n \"totalSum\": \"4950,00\",\n \"vat\": \"280,20\",\n \"accounts\": [\n {\n \"account\": \"3041\",\n \"periodicity\": {\n \"offsetAccount\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\"\n },\n \"project\": {\n \"targetValue\": \"P657588\"\n },\n \"costBearer\": {\n \"targetValue\": \"10\"\n },\n \"resultsCentre\": {\n \"targetValue\": \"20\"\n },\n \"debit\": \"\",\n \"credit\": \"4669,80\"\n }\n ]\n}" } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\r\n \"success\": true,\r\n \"data\": {\r\n \"customerID\": \"1\",\r\n \"description\": \"Music license fee for period 2025-07-01 to 2025-12-31\",\r\n \"verificationSeries\": \"A\",\r\n \"invoiceDate\": \"2025-10-06\",\r\n \"dueDate\": \"2025-11-05\",\r\n \"invoiceNumber\": \"779191\",\r\n \"ocrNumber\": \"22880377919146\",\r\n \"referenceNumber\": \"12345\",\r\n \"orderNumber\": \"12345\",\r\n \"ourRef\": \"Accounts Receivable\",\r\n \"yourRef\": \"Jon Johansson\",\r\n \"totalSum\": \"4950,00\",\r\n \"vat\": \"990,00\",\r\n \"accounts\": [\r\n {\r\n \"account\": \"3041\",\r\n \"periodicity\": {\r\n \"offsetAccount\": \"\",\r\n \"startDate\": \"\",\r\n \"endDate\": \"\"\r\n },\r\n \"project\": {\r\n \"targetValue\": \"P657588\"\r\n },\r\n \"costBearer\": {\r\n \"targetValue\": \"10\"\r\n },\r\n \"resultsCentre\": {\r\n \"targetValue\": \"20\"\r\n },\r\n \"debit\": \"\",\r\n \"credit\": \"3960,00\"\r\n }\r\n ]\r\n },\r\n \"extended\": \"\",\r\n \"meta\": \"\",\r\n \"origin\": \"\",\r\n \"time\": \"2026-08-06 10:10:00\"\r\n}" }, { "name": "Bad Request", "originalRequest": { "method": "PUT", "header": [ { "key": "Client-Key", "value": "{{clientKey}}", "description": "(Required) Your unique client key." }, { "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}", "description": "(Required) Your unique subscription key." }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/companies/:companyID/files/:fileID/customerInvoices", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "files", ":fileID", "customerInvoices" ], "query": [], "variable": [ { "key": "companyID", "value": "1", "description": "(Required) The company's unique ID." }, { "key": "fileID", "value": "2", "description": "(Required) The file's unique ID." } ] }, "description": "Bookkeep a customer invoice.", "body": { "mode": "raw", "raw": "{\n \"customerID\": \"1\",\n \"description\": \"Music license fee for period 2025-07-01 to 2025-12-31\",\n \"verificationSeries\": \"A\",\n \"invoiceDate\": \"2025-10-06\",\n \"dueDate\": \"2025-11-05\",\n \"invoiceNumber\": \"779191\",\n \"ocrNumber\": \"22880377919146\",\n \"referenceNumber\": \"12345\",\n \"orderNumber\": \"12345\",\n \"ourRef\": \"Accounts Receivable\",\n \"yourRef\": \"Jon Johansson\",\n \"totalSum\": \"4950,00\",\n \"vat\": \"280,20\",\n \"accounts\": [\n {\n \"account\": \"3041\",\n \"periodicity\": {\n \"offsetAccount\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\"\n },\n \"project\": {\n \"targetValue\": \"P657588\"\n },\n \"costBearer\": {\n \"targetValue\": \"10\"\n },\n \"resultsCentre\": {\n \"targetValue\": \"20\"\n },\n \"debit\": \"\",\n \"credit\": \"4669,80\"\n }\n ]\n}" } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\r\n \"success\": false,\r\n \"data\": [\r\n {\r\n \"code\": 321602,\r\n \"message\": \"Date is not valid.\",\r\n \"details\": \"\",\r\n \"element\": \"invoiceDate\"\r\n },\r\n {\r\n \"code\": 325492,\r\n \"message\": \"Debit and credit do not balance.\",\r\n \"details\": \"\",\r\n \"element\": \"\"\r\n }\r\n ],\r\n \"extended\": \"\",\r\n \"meta\": \"\",\r\n \"origin\": \"\",\r\n \"time\": \"2026-08-06 10:10:30\"\r\n}" }, { "name": "Not Found", "originalRequest": { "method": "PUT", "header": [ { "key": "Client-Key", "value": "{{clientKey}}", "description": "(Required) Your unique client key." }, { "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}", "description": "(Required) Your unique subscription key." }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/companies/:companyID/files/:fileID/customerInvoices", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "files", ":fileID", "customerInvoices" ], "query": [], "variable": [ { "key": "companyID", "value": "1", "description": "(Required) The company's unique ID." }, { "key": "fileID", "value": "2", "description": "(Required) The file's unique ID." } ] }, "description": "Bookkeep a customer invoice.", "body": { "mode": "raw", "raw": "{\n \"customerID\": \"1\",\n \"description\": \"Music license fee for period 2025-07-01 to 2025-12-31\",\n \"verificationSeries\": \"A\",\n \"invoiceDate\": \"2025-10-06\",\n \"dueDate\": \"2025-11-05\",\n \"invoiceNumber\": \"779191\",\n \"ocrNumber\": \"22880377919146\",\n \"referenceNumber\": \"12345\",\n \"orderNumber\": \"12345\",\n \"ourRef\": \"Accounts Receivable\",\n \"yourRef\": \"Jon Johansson\",\n \"totalSum\": \"4950,00\",\n \"vat\": \"280,20\",\n \"accounts\": [\n {\n \"account\": \"3041\",\n \"periodicity\": {\n \"offsetAccount\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\"\n },\n \"project\": {\n \"targetValue\": \"P657588\"\n },\n \"costBearer\": {\n \"targetValue\": \"10\"\n },\n \"resultsCentre\": {\n \"targetValue\": \"20\"\n },\n \"debit\": \"\",\n \"credit\": \"4669,80\"\n }\n ]\n}" } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\r\n \"success\": false,\r\n \"data\": [\r\n {\r\n \"code\": 621401,\r\n \"message\": \"Customer ID not found.\",\r\n \"details\": \"\",\r\n \"element\": \"customerID\"\r\n }\r\n ],\r\n \"extended\": \"\",\r\n \"meta\": \"\",\r\n \"origin\": \"\",\r\n \"time\": \"2026-08-06 10:11:00\"\r\n}" }, { "name": "Precondition Failed", "originalRequest": { "method": "PUT", "header": [ { "key": "Client-Key", "value": "{{clientKey}}", "description": "(Required) Your unique client key." }, { "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}", "description": "(Required) Your unique subscription key." }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/companies/:companyID/files/:fileID/customerInvoices", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "files", ":fileID", "customerInvoices" ], "query": [], "variable": [ { "key": "companyID", "value": "1", "description": "(Required) The company's unique ID." }, { "key": "fileID", "value": "2", "description": "(Required) The file's unique ID." } ] }, "description": "Bookkeep a customer invoice.", "body": { "mode": "raw", "raw": "{\n \"customerID\": \"1\",\n \"description\": \"Music license fee for period 2025-07-01 to 2025-12-31\",\n \"verificationSeries\": \"A\",\n \"invoiceDate\": \"2025-10-06\",\n \"dueDate\": \"2025-11-05\",\n \"invoiceNumber\": \"779191\",\n \"ocrNumber\": \"22880377919146\",\n \"referenceNumber\": \"12345\",\n \"orderNumber\": \"12345\",\n \"ourRef\": \"Accounts Receivable\",\n \"yourRef\": \"Jon Johansson\",\n \"totalSum\": \"4950,00\",\n \"vat\": \"280,20\",\n \"accounts\": [\n {\n \"account\": \"3041\",\n \"periodicity\": {\n \"offsetAccount\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\"\n },\n \"project\": {\n \"targetValue\": \"P657588\"\n },\n \"costBearer\": {\n \"targetValue\": \"10\"\n },\n \"resultsCentre\": {\n \"targetValue\": \"20\"\n },\n \"debit\": \"\",\n \"credit\": \"4669,80\"\n }\n ]\n}" } }, "status": "Precondition Failed", "code": 412, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\r\n \"success\": false,\r\n \"data\": [\r\n {\r\n \"code\": 211215,\r\n \"message\": \"File is not ready for extraction.\",\r\n \"details\": \"\",\r\n \"element\": \"file\"\r\n }\r\n ],\r\n \"extended\": \"\",\r\n \"meta\": \"\",\r\n \"origin\": \"\",\r\n \"time\": \"2026-08-06 10:11:30\"\r\n}" }, { "name": "Internal Server Error", "originalRequest": { "method": "PUT", "header": [ { "key": "Client-Key", "value": "{{clientKey}}", "description": "(Required) Your unique client key." }, { "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}", "description": "(Required) Your unique subscription key." }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/companies/:companyID/files/:fileID/customerInvoices", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "files", ":fileID", "customerInvoices" ], "query": [], "variable": [ { "key": "companyID", "value": "1", "description": "(Required) The company's unique ID." }, { "key": "fileID", "value": "2", "description": "(Required) The file's unique ID." } ] }, "description": "Bookkeep a customer invoice.", "body": { "mode": "raw", "raw": "{\n \"customerID\": \"1\",\n \"description\": \"Music license fee for period 2025-07-01 to 2025-12-31\",\n \"verificationSeries\": \"A\",\n \"invoiceDate\": \"2025-10-06\",\n \"dueDate\": \"2025-11-05\",\n \"invoiceNumber\": \"779191\",\n \"ocrNumber\": \"22880377919146\",\n \"referenceNumber\": \"12345\",\n \"orderNumber\": \"12345\",\n \"ourRef\": \"Accounts Receivable\",\n \"yourRef\": \"Jon Johansson\",\n \"totalSum\": \"4950,00\",\n \"vat\": \"280,20\",\n \"accounts\": [\n {\n \"account\": \"3041\",\n \"periodicity\": {\n \"offsetAccount\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\"\n },\n \"project\": {\n \"targetValue\": \"P657588\"\n },\n \"costBearer\": {\n \"targetValue\": \"10\"\n },\n \"resultsCentre\": {\n \"targetValue\": \"20\"\n },\n \"debit\": \"\",\n \"credit\": \"4669,80\"\n }\n ]\n}" } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\r\n \"success\": false,\r\n \"data\": [\r\n {\r\n \"code\": 1009220,\r\n \"message\": \"Database operation failed.\",\r\n \"details\": \"\",\r\n \"element\": \"\"\r\n }\r\n ],\r\n \"extended\": \"\",\r\n \"meta\": \"\",\r\n \"origin\": \"\",\r\n \"time\": \"2026-08-06 10:12:00\"\r\n}" } ] } ] }, { "name": "Patterns", "item": [ { "name": "Retrieve all patterns", "request": { "method": "GET", "header": [ { "key": "Client-Key", "value": "{{clientKey}}", "description": "(Required) Your unique client key." }, { "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}", "description": "(Required) Your unique subscription key." } ], "url": { "raw": "{{baseUrl}}/companies/:companyID/patterns?source=client&pageNumber=1&pageSize=10", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "patterns" ], "query": [ { "key": "source", "value": "client", "description": "Filter by pattern source." }, { "key": "pageNumber", "value": "1", "description": "The page number to retrieve." }, { "key": "pageSize", "value": "10", "description": "The number of patterns per page." } ], "variable": [ { "key": "companyID", "value": "1", "description": "(Required) The company's unique ID." } ] }, "description": "Retrieve all patterns." }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Client-Key", "value": "{{clientKey}}", "description": "(Required) Your unique client key." }, { "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}", "description": "(Required) Your unique subscription key." } ], "url": { "raw": "{{baseUrl}}/companies/:companyID/patterns?source=client&pageNumber=1&pageSize=10", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "patterns" ], "query": [ { "key": "source", "value": "client", "description": "Filter by pattern source." }, { "key": "pageNumber", "value": "1", "description": "The page number to retrieve." }, { "key": "pageSize", "value": "10", "description": "The number of patterns per page." } ], "variable": [ { "key": "companyID", "value": "1", "description": "(Required) The company's unique ID." } ] }, "description": "Retrieve all patterns." }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\r\n \"success\": true,\r\n \"data\": {\r\n \"patterns\": [\r\n {\r\n \"patternID\": \"1\",\r\n \"type\": \"SupplierInvoice\",\r\n \"verificationSeries\": \"A\",\r\n \"identifiers\": [\r\n \"telavox\",\r\n \"telecom\",\r\n \"invoice\"\r\n ],\r\n \"source\": \"client\",\r\n \"createdDate\": \"2026-08-06 12:00:00\"\r\n },\r\n {\r\n \"patternID\": \"2\",\r\n \"type\": \"Receipt\",\r\n \"verificationSeries\": \"\",\r\n \"identifiers\": [\r\n \"parking\",\r\n \"receipt\",\r\n \"garage\"\r\n ],\r\n \"source\": \"provider\",\r\n \"createdDate\": \"2026-08-05 09:30:00\"\r\n }\r\n ]\r\n },\r\n \"extended\": \"\",\r\n \"meta\": {\r\n \"pagination\": {\r\n \"pageNumber\": 1,\r\n \"pageSize\": 10,\r\n \"totalItems\": 2,\r\n \"totalPages\": 1\r\n }\r\n },\r\n \"origin\": \"\",\r\n \"time\": \"2026-08-06 12:20:00\"\r\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "key": "Client-Key", "value": "{{clientKey}}", "description": "(Required) Your unique client key." }, { "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}", "description": "(Required) Your unique subscription key." } ], "url": { "raw": "{{baseUrl}}/companies/:companyID/patterns?source=client&pageNumber=1&pageSize=10", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "patterns" ], "query": [ { "key": "source", "value": "client", "description": "Filter by pattern source." }, { "key": "pageNumber", "value": "1", "description": "The page number to retrieve." }, { "key": "pageSize", "value": "10", "description": "The number of patterns per page." } ], "variable": [ { "key": "companyID", "value": "1", "description": "(Required) The company's unique ID." } ] }, "description": "Retrieve all patterns." }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\r\n \"success\": false,\r\n \"data\": [\r\n {\r\n \"code\": 101152,\r\n \"message\": \"Query parameter is not valid\",\r\n \"details\": \"pageSize must be between 1 and 100.\",\r\n \"element\": \"pageSize\"\r\n }\r\n ],\r\n \"extended\": \"\",\r\n \"meta\": \"\",\r\n \"origin\": \"\",\r\n \"time\": \"2026-08-06 12:20:30\"\r\n}" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "key": "Client-Key", "value": "{{clientKey}}", "description": "(Required) Your unique client key." }, { "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}", "description": "(Required) Your unique subscription key." } ], "url": { "raw": "{{baseUrl}}/companies/:companyID/patterns?source=client&pageNumber=1&pageSize=10", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "patterns" ], "query": [ { "key": "source", "value": "client", "description": "Filter by pattern source." }, { "key": "pageNumber", "value": "1", "description": "The page number to retrieve." }, { "key": "pageSize", "value": "10", "description": "The number of patterns per page." } ], "variable": [ { "key": "companyID", "value": "1", "description": "(Required) The company's unique ID." } ] }, "description": "Retrieve all patterns." }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\r\n \"success\": false,\r\n \"data\": [\r\n {\r\n \"code\": 111401,\r\n \"message\": \"Company ID not found.\",\r\n \"details\": \"\",\r\n \"element\": \"companyID\"\r\n }\r\n ],\r\n \"extended\": \"\",\r\n \"meta\": \"\",\r\n \"origin\": \"\",\r\n \"time\": \"2026-08-06 12:21:00\"\r\n}" }, { "name": "Internal Server Error", "originalRequest": { "method": "GET", "header": [ { "key": "Client-Key", "value": "{{clientKey}}", "description": "(Required) Your unique client key." }, { "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}", "description": "(Required) Your unique subscription key." } ], "url": { "raw": "{{baseUrl}}/companies/:companyID/patterns?source=client&pageNumber=1&pageSize=10", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "patterns" ], "query": [ { "key": "source", "value": "client", "description": "Filter by pattern source." }, { "key": "pageNumber", "value": "1", "description": "The page number to retrieve." }, { "key": "pageSize", "value": "10", "description": "The number of patterns per page." } ], "variable": [ { "key": "companyID", "value": "1", "description": "(Required) The company's unique ID." } ] }, "description": "Retrieve all patterns." }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\r\n \"success\": false,\r\n \"data\": [\r\n {\r\n \"code\": 1009220,\r\n \"message\": \"Database operation failed.\",\r\n \"details\": \"\",\r\n \"element\": \"\"\r\n }\r\n ],\r\n \"extended\": \"\",\r\n \"meta\": \"\",\r\n \"origin\": \"\",\r\n \"time\": \"2026-08-06 12:21:30\"\r\n}" } ] }, { "name": "Retrieve a pattern", "request": { "method": "GET", "header": [ { "key": "Client-Key", "value": "{{clientKey}}", "description": "(Required) Your unique client key." }, { "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}", "description": "(Required) Your unique subscription key." } ], "url": { "raw": "{{baseUrl}}/companies/:companyID/patterns/:patternID", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "patterns", ":patternID" ], "query": [], "variable": [ { "key": "companyID", "value": "1", "description": "(Required) The company's unique ID." }, { "key": "patternID", "value": "1", "description": "(Required) The pattern's unique ID." } ] }, "description": "Retrieve a pattern." }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Client-Key", "value": "{{clientKey}}", "description": "(Required) Your unique client key." }, { "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}", "description": "(Required) Your unique subscription key." } ], "url": { "raw": "{{baseUrl}}/companies/:companyID/patterns/:patternID", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "patterns", ":patternID" ], "query": [], "variable": [ { "key": "companyID", "value": "1", "description": "(Required) The company's unique ID." }, { "key": "patternID", "value": "1", "description": "(Required) The pattern's unique ID." } ] }, "description": "Retrieve a pattern." }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\r\n \"success\": true,\r\n \"data\": {\r\n \"patternID\": \"1\",\r\n \"type\": \"SupplierInvoice\",\r\n \"verificationSeries\": \"A\",\r\n \"identifiers\": [\r\n \"telavox\",\r\n \"telecom\",\r\n \"invoice\"\r\n ],\r\n \"source\": \"client\",\r\n \"createdDate\": \"2026-08-06 12:10:00\"\r\n },\r\n \"extended\": \"\",\r\n \"meta\": \"\",\r\n \"origin\": \"\",\r\n \"time\": \"2026-08-06 12:10:00\"\r\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "key": "Client-Key", "value": "{{clientKey}}", "description": "(Required) Your unique client key." }, { "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}", "description": "(Required) Your unique subscription key." } ], "url": { "raw": "{{baseUrl}}/companies/:companyID/patterns/:patternID", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "patterns", ":patternID" ], "query": [], "variable": [ { "key": "companyID", "value": "1", "description": "(Required) The company's unique ID." }, { "key": "patternID", "value": "1", "description": "(Required) The pattern's unique ID." } ] }, "description": "Retrieve a pattern." }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\r\n \"success\": false,\r\n \"data\": [\r\n {\r\n \"code\": 461402,\r\n \"message\": \"Pattern ID is not valid.\",\r\n \"details\": \"\",\r\n \"element\": \"patternID\"\r\n }\r\n ],\r\n \"extended\": \"\",\r\n \"meta\": \"\",\r\n \"origin\": \"\",\r\n \"time\": \"2026-08-06 12:10:30\"\r\n}" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "key": "Client-Key", "value": "{{clientKey}}", "description": "(Required) Your unique client key." }, { "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}", "description": "(Required) Your unique subscription key." } ], "url": { "raw": "{{baseUrl}}/companies/:companyID/patterns/:patternID", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "patterns", ":patternID" ], "query": [], "variable": [ { "key": "companyID", "value": "1", "description": "(Required) The company's unique ID." }, { "key": "patternID", "value": "1", "description": "(Required) The pattern's unique ID." } ] }, "description": "Retrieve a pattern." }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\r\n \"success\": false,\r\n \"data\": [\r\n {\r\n \"code\": 461401,\r\n \"message\": \"Pattern ID not found.\",\r\n \"details\": \"\",\r\n \"element\": \"patternID\"\r\n }\r\n ],\r\n \"extended\": \"\",\r\n \"meta\": \"\",\r\n \"origin\": \"\",\r\n \"time\": \"2026-08-06 12:11:00\"\r\n}" }, { "name": "Internal Server Error", "originalRequest": { "method": "GET", "header": [ { "key": "Client-Key", "value": "{{clientKey}}", "description": "(Required) Your unique client key." }, { "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}", "description": "(Required) Your unique subscription key." } ], "url": { "raw": "{{baseUrl}}/companies/:companyID/patterns/:patternID", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "patterns", ":patternID" ], "query": [], "variable": [ { "key": "companyID", "value": "1", "description": "(Required) The company's unique ID." }, { "key": "patternID", "value": "1", "description": "(Required) The pattern's unique ID." } ] }, "description": "Retrieve a pattern." }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\r\n \"success\": false,\r\n \"data\": [\r\n {\r\n \"code\": 1009220,\r\n \"message\": \"Database operation failed.\",\r\n \"details\": \"\",\r\n \"element\": \"\"\r\n }\r\n ],\r\n \"extended\": \"\",\r\n \"meta\": \"\",\r\n \"origin\": \"\",\r\n \"time\": \"2026-08-06 12:11:30\"\r\n}" } ] }, { "name": "Create a pattern", "request": { "method": "POST", "header": [ { "key": "Client-Key", "value": "{{clientKey}}", "description": "(Required) Your unique client key." }, { "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}", "description": "(Required) Your unique subscription key." }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/companies/:companyID/patterns", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "patterns" ], "query": [], "variable": [ { "key": "companyID", "value": "1", "description": "(Required) The company's unique ID." } ] }, "description": "Create a pattern.", "body": { "mode": "raw", "raw": "{\r\n \"patternID\": \"1\",\r\n \"type\": \"SupplierInvoice\",\r\n \"verificationSeries\": \"A\",\r\n \"identifiers\": [\r\n \"telavox\",\r\n \"telecom\",\r\n \"invoice\"\r\n ],\r\n \"source\": \"client\"\r\n}" } }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "key": "Client-Key", "value": "{{clientKey}}", "description": "(Required) Your unique client key." }, { "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}", "description": "(Required) Your unique subscription key." }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/companies/:companyID/patterns", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "patterns" ], "query": [], "variable": [ { "key": "companyID", "value": "1", "description": "(Required) The company's unique ID." } ] }, "description": "Create a pattern.", "body": { "mode": "raw", "raw": "{\n \"patternID\": \"1\",\n \"type\": \"SupplierInvoice\",\n \"verificationSeries\": \"A\",\n \"identifiers\": [\n \"telavox\",\n \"telecom\",\n \"invoice\"\n ],\n \"source\": \"client\"\n}" } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\r\n \"success\": true,\r\n \"data\": {\r\n \"patternID\": \"1\",\r\n \"type\": \"SupplierInvoice\",\r\n \"verificationSeries\": \"A\",\r\n \"identifiers\": [\r\n \"telavox\",\r\n \"telecom\",\r\n \"invoice\"\r\n ],\r\n \"source\": \"client\",\r\n \"createdDate\": \"2026-08-06 12:00:00\"\r\n },\r\n \"extended\": \"\",\r\n \"meta\": \"\",\r\n \"origin\": \"\",\r\n \"time\": \"2026-08-06 12:00:00\"\r\n}" }, { "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "key": "Client-Key", "value": "{{clientKey}}", "description": "(Required) Your unique client key." }, { "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}", "description": "(Required) Your unique subscription key." }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/companies/:companyID/patterns", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "patterns" ], "query": [], "variable": [ { "key": "companyID", "value": "1", "description": "(Required) The company's unique ID." } ] }, "description": "Create a pattern.", "body": { "mode": "raw", "raw": "{\n \"patternID\": \"1\",\n \"type\": \"SupplierInvoice\",\n \"verificationSeries\": \"A\",\n \"identifiers\": [\n \"telavox\",\n \"telecom\",\n \"invoice\"\n ],\n \"source\": \"client\"\n}" } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\r\n \"success\": false,\r\n \"data\": [\r\n {\r\n \"code\": 461102,\r\n \"message\": \"Identifiers are not valid.\",\r\n \"details\": \"Invalid identifiers: 'tel avox'. Each identifier must be a single token, 3-25 characters, letters a-z only, with no spaces or diacritics.\",\r\n \"element\": \"identifiers\"\r\n }\r\n ],\r\n \"extended\": \"\",\r\n \"meta\": \"\",\r\n \"origin\": \"\",\r\n \"time\": \"2026-08-06 12:00:30\"\r\n}" }, { "name": "Not Found", "originalRequest": { "method": "POST", "header": [ { "key": "Client-Key", "value": "{{clientKey}}", "description": "(Required) Your unique client key." }, { "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}", "description": "(Required) Your unique subscription key." }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/companies/:companyID/patterns", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "patterns" ], "query": [], "variable": [ { "key": "companyID", "value": "1", "description": "(Required) The company's unique ID." } ] }, "description": "Create a pattern.", "body": { "mode": "raw", "raw": "{\n \"patternID\": \"1\",\n \"type\": \"SupplierInvoice\",\n \"verificationSeries\": \"A\",\n \"identifiers\": [\n \"telavox\",\n \"telecom\",\n \"invoice\"\n ],\n \"source\": \"client\"\n}" } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\r\n \"success\": false,\r\n \"data\": [\r\n {\r\n \"code\": 111401,\r\n \"message\": \"Company ID not found.\",\r\n \"details\": \"\",\r\n \"element\": \"companyID\"\r\n }\r\n ],\r\n \"extended\": \"\",\r\n \"meta\": \"\",\r\n \"origin\": \"\",\r\n \"time\": \"2026-08-06 12:01:00\"\r\n}" }, { "name": "Internal Server Error", "originalRequest": { "method": "POST", "header": [ { "key": "Client-Key", "value": "{{clientKey}}", "description": "(Required) Your unique client key." }, { "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}", "description": "(Required) Your unique subscription key." }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/companies/:companyID/patterns", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "patterns" ], "query": [], "variable": [ { "key": "companyID", "value": "1", "description": "(Required) The company's unique ID." } ] }, "description": "Create a pattern.", "body": { "mode": "raw", "raw": "{\n \"patternID\": \"1\",\n \"type\": \"SupplierInvoice\",\n \"verificationSeries\": \"A\",\n \"identifiers\": [\n \"telavox\",\n \"telecom\",\n \"invoice\"\n ],\n \"source\": \"client\"\n}" } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\r\n \"success\": false,\r\n \"data\": [\r\n {\r\n \"code\": 1009220,\r\n \"message\": \"Database operation failed.\",\r\n \"details\": \"\",\r\n \"element\": \"\"\r\n }\r\n ],\r\n \"extended\": \"\",\r\n \"meta\": \"\",\r\n \"origin\": \"\",\r\n \"time\": \"2026-08-06 12:01:30\"\r\n}" } ] }, { "name": "Update a pattern", "request": { "method": "PUT", "header": [ { "key": "Client-Key", "value": "{{clientKey}}", "description": "(Required) Your unique client key." }, { "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}", "description": "(Required) Your unique subscription key." }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/companies/:companyID/patterns/:patternID", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "patterns", ":patternID" ], "query": [], "variable": [ { "key": "companyID", "value": "1", "description": "(Required) The company's unique ID." }, { "key": "patternID", "value": "1", "description": "(Required) The pattern's unique ID." } ] }, "description": "Update a pattern.", "body": { "mode": "raw", "raw": "{\r\n \"patternID\": \"1\",\r\n \"type\": \"SupplierInvoice\",\r\n \"verificationSeries\": \"A\",\r\n \"identifiers\": [\r\n \"telavox\",\r\n \"telecom\",\r\n \"invoice\"\r\n ],\r\n \"source\": \"client\"\r\n}" } }, "response": [ { "name": "OK", "originalRequest": { "method": "PUT", "header": [ { "key": "Client-Key", "value": "{{clientKey}}", "description": "(Required) Your unique client key." }, { "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}", "description": "(Required) Your unique subscription key." }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/companies/:companyID/patterns/:patternID", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "patterns", ":patternID" ], "query": [], "variable": [ { "key": "companyID", "value": "1", "description": "(Required) The company's unique ID." }, { "key": "patternID", "value": "1", "description": "(Required) The pattern's unique ID." } ] }, "description": "Update a pattern.", "body": { "mode": "raw", "raw": "{\n \"patternID\": \"1\",\n \"type\": \"SupplierInvoice\",\n \"verificationSeries\": \"A\",\n \"identifiers\": [\n \"telavox\",\n \"telecom\",\n \"invoice\"\n ],\n \"source\": \"client\"\n}" } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\r\n \"success\": true,\r\n \"data\": {\r\n \"patternID\": \"1\",\r\n \"type\": \"SupplierInvoice\",\r\n \"verificationSeries\": \"A\",\r\n \"identifiers\": [\r\n \"telavox\",\r\n \"telecom\",\r\n \"invoice\"\r\n ],\r\n \"source\": \"client\",\r\n \"createdDate\": \"2026-08-06 12:30:00\"\r\n },\r\n \"extended\": \"\",\r\n \"meta\": \"\",\r\n \"origin\": \"\",\r\n \"time\": \"2026-08-06 12:30:00\"\r\n}" }, { "name": "Bad Request", "originalRequest": { "method": "PUT", "header": [ { "key": "Client-Key", "value": "{{clientKey}}", "description": "(Required) Your unique client key." }, { "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}", "description": "(Required) Your unique subscription key." }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/companies/:companyID/patterns/:patternID", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "patterns", ":patternID" ], "query": [], "variable": [ { "key": "companyID", "value": "1", "description": "(Required) The company's unique ID." }, { "key": "patternID", "value": "1", "description": "(Required) The pattern's unique ID." } ] }, "description": "Update a pattern.", "body": { "mode": "raw", "raw": "{\n \"patternID\": \"1\",\n \"type\": \"SupplierInvoice\",\n \"verificationSeries\": \"A\",\n \"identifiers\": [\n \"telavox\",\n \"telecom\",\n \"invoice\"\n ],\n \"source\": \"client\"\n}" } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\r\n \"success\": false,\r\n \"data\": [\r\n {\r\n \"code\": 461213,\r\n \"message\": \"Pattern already exists.\",\r\n \"details\": \"\",\r\n \"element\": \"identifiers\"\r\n }\r\n ],\r\n \"extended\": \"\",\r\n \"meta\": \"\",\r\n \"origin\": \"\",\r\n \"time\": \"2026-08-06 12:30:30\"\r\n}" }, { "name": "Not Found", "originalRequest": { "method": "PUT", "header": [ { "key": "Client-Key", "value": "{{clientKey}}", "description": "(Required) Your unique client key." }, { "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}", "description": "(Required) Your unique subscription key." }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/companies/:companyID/patterns/:patternID", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "patterns", ":patternID" ], "query": [], "variable": [ { "key": "companyID", "value": "1", "description": "(Required) The company's unique ID." }, { "key": "patternID", "value": "1", "description": "(Required) The pattern's unique ID." } ] }, "description": "Update a pattern.", "body": { "mode": "raw", "raw": "{\n \"patternID\": \"1\",\n \"type\": \"SupplierInvoice\",\n \"verificationSeries\": \"A\",\n \"identifiers\": [\n \"telavox\",\n \"telecom\",\n \"invoice\"\n ],\n \"source\": \"client\"\n}" } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\r\n \"success\": false,\r\n \"data\": [\r\n {\r\n \"code\": 461401,\r\n \"message\": \"Pattern ID not found.\",\r\n \"details\": \"\",\r\n \"element\": \"patternID\"\r\n }\r\n ],\r\n \"extended\": \"\",\r\n \"meta\": \"\",\r\n \"origin\": \"\",\r\n \"time\": \"2026-08-06 12:31:00\"\r\n}" }, { "name": "Internal Server Error", "originalRequest": { "method": "PUT", "header": [ { "key": "Client-Key", "value": "{{clientKey}}", "description": "(Required) Your unique client key." }, { "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}", "description": "(Required) Your unique subscription key." }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/companies/:companyID/patterns/:patternID", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "patterns", ":patternID" ], "query": [], "variable": [ { "key": "companyID", "value": "1", "description": "(Required) The company's unique ID." }, { "key": "patternID", "value": "1", "description": "(Required) The pattern's unique ID." } ] }, "description": "Update a pattern.", "body": { "mode": "raw", "raw": "{\n \"patternID\": \"1\",\n \"type\": \"SupplierInvoice\",\n \"verificationSeries\": \"A\",\n \"identifiers\": [\n \"telavox\",\n \"telecom\",\n \"invoice\"\n ],\n \"source\": \"client\"\n}" } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\r\n \"success\": false,\r\n \"data\": [\r\n {\r\n \"code\": 1009220,\r\n \"message\": \"Database operation failed.\",\r\n \"details\": \"\",\r\n \"element\": \"\"\r\n }\r\n ],\r\n \"extended\": \"\",\r\n \"meta\": \"\",\r\n \"origin\": \"\",\r\n \"time\": \"2026-08-06 12:31:30\"\r\n}" } ] }, { "name": "Delete a pattern", "request": { "method": "DELETE", "header": [ { "key": "Client-Key", "value": "{{clientKey}}", "description": "(Required) Your unique client key." }, { "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}", "description": "(Required) Your unique subscription key." } ], "url": { "raw": "{{baseUrl}}/companies/:companyID/patterns/:patternID", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "patterns", ":patternID" ], "query": [], "variable": [ { "key": "companyID", "value": "1", "description": "(Required) The company's unique ID." }, { "key": "patternID", "value": "1", "description": "(Required) The pattern's unique ID." } ] }, "description": "Delete a pattern." }, "response": [ { "name": "OK", "originalRequest": { "method": "DELETE", "header": [ { "key": "Client-Key", "value": "{{clientKey}}", "description": "(Required) Your unique client key." }, { "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}", "description": "(Required) Your unique subscription key." } ], "url": { "raw": "{{baseUrl}}/companies/:companyID/patterns/:patternID", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "patterns", ":patternID" ], "query": [], "variable": [ { "key": "companyID", "value": "1", "description": "(Required) The company's unique ID." }, { "key": "patternID", "value": "1", "description": "(Required) The pattern's unique ID." } ] }, "description": "Delete a pattern." }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\r\n \"success\": true,\r\n \"data\": {},\r\n \"extended\": \"\",\r\n \"meta\": \"\",\r\n \"origin\": \"\",\r\n \"time\": \"2026-08-06 12:30:00\"\r\n}" }, { "name": "Bad Request", "originalRequest": { "method": "DELETE", "header": [ { "key": "Client-Key", "value": "{{clientKey}}", "description": "(Required) Your unique client key." }, { "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}", "description": "(Required) Your unique subscription key." } ], "url": { "raw": "{{baseUrl}}/companies/:companyID/patterns/:patternID", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "patterns", ":patternID" ], "query": [], "variable": [ { "key": "companyID", "value": "1", "description": "(Required) The company's unique ID." }, { "key": "patternID", "value": "1", "description": "(Required) The pattern's unique ID." } ] }, "description": "Delete a pattern." }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\r\n \"success\": false,\r\n \"data\": [\r\n {\r\n \"code\": 111402,\r\n \"message\": \"Company ID is not valid.\",\r\n \"details\": \"\",\r\n \"element\": \"companyID\"\r\n }\r\n ],\r\n \"extended\": \"\",\r\n \"meta\": \"\",\r\n \"origin\": \"\",\r\n \"time\": \"2026-08-06 12:30:30\"\r\n}" }, { "name": "Not Found", "originalRequest": { "method": "DELETE", "header": [ { "key": "Client-Key", "value": "{{clientKey}}", "description": "(Required) Your unique client key." }, { "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}", "description": "(Required) Your unique subscription key." } ], "url": { "raw": "{{baseUrl}}/companies/:companyID/patterns/:patternID", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "patterns", ":patternID" ], "query": [], "variable": [ { "key": "companyID", "value": "1", "description": "(Required) The company's unique ID." }, { "key": "patternID", "value": "1", "description": "(Required) The pattern's unique ID." } ] }, "description": "Delete a pattern." }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\r\n \"success\": false,\r\n \"data\": [\r\n {\r\n \"code\": 461401,\r\n \"message\": \"Pattern ID not found.\",\r\n \"details\": \"\",\r\n \"element\": \"patternID\"\r\n }\r\n ],\r\n \"extended\": \"\",\r\n \"meta\": \"\",\r\n \"origin\": \"\",\r\n \"time\": \"2026-08-06 12:31:00\"\r\n}" }, { "name": "Internal Server Error", "originalRequest": { "method": "DELETE", "header": [ { "key": "Client-Key", "value": "{{clientKey}}", "description": "(Required) Your unique client key." }, { "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}", "description": "(Required) Your unique subscription key." } ], "url": { "raw": "{{baseUrl}}/companies/:companyID/patterns/:patternID", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "patterns", ":patternID" ], "query": [], "variable": [ { "key": "companyID", "value": "1", "description": "(Required) The company's unique ID." }, { "key": "patternID", "value": "1", "description": "(Required) The pattern's unique ID." } ] }, "description": "Delete a pattern." }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\r\n \"success\": false,\r\n \"data\": [\r\n {\r\n \"code\": 1009220,\r\n \"message\": \"Database operation failed.\",\r\n \"details\": \"\",\r\n \"element\": \"\"\r\n }\r\n ],\r\n \"extended\": \"\",\r\n \"meta\": \"\",\r\n \"origin\": \"\",\r\n \"time\": \"2026-08-06 12:31:30\"\r\n}" } ] } ] }, { "name": "Progenitors", "item": [ { "name": "Add a progenitor", "request": { "method": "POST", "header": [ { "description": "(Required) Your unique client key.", "key": "Client-Key", "value": "{{clientKey}}" }, { "description": "(Required) Your unique subscription key.", "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\r\n \"progenitorID\": \"c1\",\r\n \"startDateTime\": \"2020-01-01 00:00:00\",\r\n \"stopDateTime\": \"2020-12-31 23:59:59\",\r\n \"supplierInvoices\": true,\r\n \"customerInvoices\": true,\r\n \"receipts\": true\r\n}" }, "url": { "raw": "{{baseUrl}}/companies/:companyID/progenitors", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "progenitors" ], "variable": [ { "key": "companyID", "value": "1", "description": "(Required) The company's unique ID." } ] }, "description": "Add a progenitor." }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) Your unique client key.", "key": "Client-Key", "value": "{{clientKey}}" }, { "description": "(Required) Your unique subscription key.", "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}" } ], "body": { "mode": "raw", "raw": "{\n \"progenitorID\": \"c1\",\n \"startDateTime\": \"2020-01-01 00:00:00\",\n \"stopDateTime\": \"2020-12-31 03:59:59\",\n \"supplierInvoices\": true,\n \"receipts\": true\n}" }, "url": { "raw": "{{baseUrl}}/companies/:companyID/progenitors", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "progenitors" ], "variable": [ { "key": "companyID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\r\n \"success\": true,\r\n \"data\": {\r\n \"progenitorID\": \"c1\",\r\n \"startDateTime\": \"2020-01-01 00:00:00\",\r\n \"stopDateTime\": \"2020-12-31 23:59:59\",\r\n \"supplierInvoices\": true,\r\n \"customerInvoices\": true,\r\n \"receipts\": true\r\n },\r\n \"extended\": \"\",\r\n \"meta\": \"\",\r\n \"origin\": \"\",\r\n \"time\": \"2026-08-06 10:50:00\"\r\n}" }, { "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) Your unique client key.", "key": "Client-Key", "value": "{{clientKey}}" }, { "description": "(Required) Your unique subscription key.", "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}" } ], "body": { "mode": "raw", "raw": "{\n \"progenitorID\": \"c1\",\n \"startDateTime\": \"2020-01-01 00:00:00\",\n \"stopDateTime\": \"2020-12-31 03:59:59\",\n \"supplierInvoices\": true,\n \"receipts\": true\n}" }, "url": { "raw": "{{baseUrl}}/companies/:companyID/progenitors", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "progenitors" ], "variable": [ { "key": "companyID" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\r\n \"success\": false,\r\n \"data\": [\r\n {\r\n \"code\": 111402,\r\n \"message\": \"Company ID is not valid.\",\r\n \"details\": \"\",\r\n \"element\": \"progenitorID\"\r\n }\r\n ],\r\n \"extended\": \"\",\r\n \"meta\": \"\",\r\n \"origin\": \"\",\r\n \"time\": \"2026-08-06 10:50:30\"\r\n}" }, { "name": "Not Found", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) Your unique client key.", "key": "Client-Key", "value": "{{clientKey}}" }, { "description": "(Required) Your unique subscription key.", "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}" } ], "body": { "mode": "raw", "raw": "{\n \"progenitorID\": \"c1\",\n \"startDateTime\": \"2020-01-01 00:00:00\",\n \"stopDateTime\": \"2020-12-31 03:59:59\",\n \"supplierInvoices\": true,\n \"receipts\": true\n}" }, "url": { "raw": "{{baseUrl}}/companies/:companyID/progenitors", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "progenitors" ], "variable": [ { "key": "companyID" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\r\n \"success\": false,\r\n \"data\": [\r\n {\r\n \"code\": 111401,\r\n \"message\": \"Company ID not found.\",\r\n \"details\": \"\",\r\n \"element\": \"companyID\"\r\n }\r\n ],\r\n \"extended\": \"\",\r\n \"meta\": \"\",\r\n \"origin\": \"\",\r\n \"time\": \"2026-08-06 10:51:00\"\r\n}" }, { "name": "Internal Server Error", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) Your unique client key.", "key": "Client-Key", "value": "{{clientKey}}" }, { "description": "(Required) Your unique subscription key.", "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}" } ], "body": { "mode": "raw", "raw": "{\n \"progenitorID\": \"c1\",\n \"startDateTime\": \"2020-01-01 00:00:00\",\n \"stopDateTime\": \"2020-12-31 03:59:59\",\n \"supplierInvoices\": true,\n \"receipts\": true\n}" }, "url": { "raw": "{{baseUrl}}/companies/:companyID/progenitors", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "progenitors" ], "variable": [ { "key": "companyID" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\r\n \"success\": false,\r\n \"data\": [\r\n {\r\n \"code\": 1009220,\r\n \"message\": \"Database operation failed.\",\r\n \"details\": \"\",\r\n \"element\": \"\"\r\n }\r\n ],\r\n \"extended\": \"\",\r\n \"meta\": \"\",\r\n \"origin\": \"\",\r\n \"time\": \"2026-08-06 10:51:30\"\r\n}" } ] }, { "name": "Add a progenitor list", "request": { "method": "POST", "header": [ { "key": "Client-Key", "value": "{{clientKey}}", "description": "(Required) Your unique client key." }, { "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}", "description": "(Required) Your unique subscription key." }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\r\n \"progenitors\": [\r\n {\r\n \"progenitorID\": \"c1\",\r\n \"startDateTime\": \"2020-01-01 00:00:00\",\r\n \"stopDateTime\": \"2020-12-31 23:59:59\",\r\n \"supplierInvoices\": true,\r\n \"customerInvoices\": true,\r\n \"receipts\": true\r\n },\r\n {\r\n \"progenitorID\": \"c2\",\r\n \"startDateTime\": \"2021-01-01 00:00:00\",\r\n \"stopDateTime\": \"\",\r\n \"supplierInvoices\": false,\r\n \"customerInvoices\": false,\r\n \"receipts\": true\r\n }\r\n ]\r\n}" }, "url": { "raw": "{{baseUrl}}/companies/:companyID/progenitors/multiple", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "progenitors", "multiple" ], "variable": [ { "key": "companyID", "value": "1", "description": "(Required) The company's unique ID." } ] }, "description": "Add a progenitor." }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) Your unique client key.", "key": "Client-Key", "value": "{{clientKey}}" }, { "description": "(Required) Your unique subscription key.", "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}" } ], "body": { "mode": "raw", "raw": "{\n \"progenitorID\": \"c1\",\n \"startDateTime\": \"2020-01-01 00:00:00\",\n \"stopDateTime\": \"2020-12-31 03:59:59\",\n \"supplierInvoices\": true,\n \"receipts\": true\n}" }, "url": { "raw": "{{baseUrl}}/companies/:companyID/progenitors", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "progenitors" ], "variable": [ { "key": "companyID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\r\n \"objectList\": [\r\n {\r\n \"success\": true,\r\n \"data\": {\r\n \"progenitorID\": \"c1\",\r\n \"startDateTime\": \"2020-01-01 00:00:00\",\r\n \"stopDateTime\": \"2020-12-31 23:59:59\",\r\n \"supplierInvoices\": true,\r\n \"customerInvoices\": true,\r\n \"receipts\": true\r\n },\r\n \"objectID\": \"1\"\r\n },\r\n {\r\n \"success\": true,\r\n \"data\": {\r\n \"progenitorID\": \"c2\",\r\n \"startDateTime\": \"2021-01-01 00:00:00\",\r\n \"stopDateTime\": \"\",\r\n \"supplierInvoices\": false,\r\n \"customerInvoices\": false,\r\n \"receipts\": true\r\n },\r\n \"objectID\": \"2\"\r\n }\r\n ],\r\n \"time\": \"2026-08-06 11:10:00\"\r\n}" }, { "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) Your unique client key.", "key": "Client-Key", "value": "{{clientKey}}" }, { "description": "(Required) Your unique subscription key.", "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}" } ], "body": { "mode": "raw", "raw": "{\n \"progenitorID\": \"c1\",\n \"startDateTime\": \"2020-01-01 00:00:00\",\n \"stopDateTime\": \"2020-12-31 03:59:59\",\n \"supplierInvoices\": true,\n \"receipts\": true\n}" }, "url": { "raw": "{{baseUrl}}/companies/:companyID/progenitors", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "progenitors" ], "variable": [ { "key": "companyID" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\r\n \"success\": false,\r\n \"data\": [\r\n {\r\n \"code\": 111402,\r\n \"message\": \"Company ID is not valid.\",\r\n \"details\": \"\",\r\n \"element\": \"companyID\"\r\n }\r\n ],\r\n \"extended\": \"\",\r\n \"meta\": \"\",\r\n \"origin\": \"\",\r\n \"time\": \"2026-08-06 11:10:30\"\r\n}" }, { "name": "Not Found", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) Your unique client key.", "key": "Client-Key", "value": "{{clientKey}}" }, { "description": "(Required) Your unique subscription key.", "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}" } ], "body": { "mode": "raw", "raw": "{\n \"progenitorID\": \"c1\",\n \"startDateTime\": \"2020-01-01 00:00:00\",\n \"stopDateTime\": \"2020-12-31 03:59:59\",\n \"supplierInvoices\": true,\n \"receipts\": true\n}" }, "url": { "raw": "{{baseUrl}}/companies/:companyID/progenitors", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "progenitors" ], "variable": [ { "key": "companyID" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\r\n \"success\": false,\r\n \"data\": [\r\n {\r\n \"code\": 111401,\r\n \"message\": \"Company ID not found.\",\r\n \"details\": \"\",\r\n \"element\": \"companyID\"\r\n }\r\n ],\r\n \"extended\": \"\",\r\n \"meta\": \"\",\r\n \"origin\": \"\",\r\n \"time\": \"2026-08-06 11:11:00\"\r\n}" }, { "name": "Conflict", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) Your unique client key.", "key": "Client-Key", "value": "{{clientKey}}" }, { "description": "(Required) Your unique subscription key.", "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}" } ], "body": { "mode": "raw", "raw": "{\n \"progenitorID\": \"c1\",\n \"startDateTime\": \"2020-01-01 00:00:00\",\n \"stopDateTime\": \"2020-12-31 03:59:59\",\n \"supplierInvoices\": true,\n \"receipts\": true\n}" }, "url": { "raw": "{{baseUrl}}/companies/:companyID/progenitors", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "progenitors" ], "variable": [ { "key": "companyID" } ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\r\n \"objectList\": [\r\n {\r\n \"success\": true,\r\n \"data\": {\r\n \"progenitorID\": \"c1\",\r\n \"startDateTime\": \"2020-01-01 00:00:00\",\r\n \"stopDateTime\": \"2020-12-31 23:59:59\",\r\n \"supplierInvoices\": true,\r\n \"customerInvoices\": true,\r\n \"receipts\": true\r\n },\r\n \"objectID\": \"1\"\r\n },\r\n {\r\n \"success\": false,\r\n \"data\": [\r\n {\r\n \"code\": 111401,\r\n \"message\": \"Company ID not found.\",\r\n \"details\": \"\",\r\n \"element\": \"progenitorID\"\r\n }\r\n ],\r\n \"objectID\": \"2\"\r\n }\r\n ],\r\n \"time\": \"2026-08-06 11:11:30\"\r\n}" }, { "name": "Internal Server Error", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) Your unique client key.", "key": "Client-Key", "value": "{{clientKey}}" }, { "description": "(Required) Your unique subscription key.", "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}" } ], "body": { "mode": "raw", "raw": "{\n \"progenitorID\": \"c1\",\n \"startDateTime\": \"2020-01-01 00:00:00\",\n \"stopDateTime\": \"2020-12-31 03:59:59\",\n \"supplierInvoices\": true,\n \"receipts\": true\n}" }, "url": { "raw": "{{baseUrl}}/companies/:companyID/progenitors", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "progenitors" ], "variable": [ { "key": "companyID" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\r\n \"success\": false,\r\n \"data\": [\r\n {\r\n \"code\": 1009220,\r\n \"message\": \"Database operation failed.\",\r\n \"details\": \"\",\r\n \"element\": \"\"\r\n }\r\n ],\r\n \"extended\": \"\",\r\n \"meta\": \"\",\r\n \"origin\": \"\",\r\n \"time\": \"2026-08-06 11:12:00\"\r\n}" } ] }, { "name": "Retrieve a progenitor", "request": { "method": "GET", "header": [ { "description": "(Required) Your unique client key.", "key": "Client-Key", "value": "{{clientKey}}" }, { "description": "(Required) Your unique subscription key.", "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}" } ], "url": { "raw": "{{baseUrl}}/companies/:companyID/progenitors/:progenitorID", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "progenitors", ":progenitorID" ], "variable": [ { "key": "companyID", "value": "1", "description": "(Required) The company's unique ID." }, { "key": "progenitorID", "value": "c1", "description": "(Required) The progenitor's unique ID." } ] }, "description": "Retrieve a progenitor." }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) Your unique client key.", "key": "Client-Key", "value": "{{clientKey}}" }, { "description": "(Required) Your unique subscription key.", "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}" } ], "url": { "raw": "{{baseUrl}}/companies/:companyID/progenitors/:progenitorID", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "progenitors", ":progenitorID" ], "variable": [ { "key": "companyID" }, { "key": "progenitorID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\r\n \"success\": true,\r\n \"data\": {\r\n \"progenitorID\": \"c1\",\r\n \"startDateTime\": \"2020-01-01 00:00:00\",\r\n \"stopDateTime\": \"2020-12-31 23:59:59\",\r\n \"supplierInvoices\": true,\r\n \"customerInvoices\": true,\r\n \"receipts\": true,\r\n \"created\": \"2020-01-01 00:05:12\"\r\n },\r\n \"extended\": \"\",\r\n \"meta\": \"\",\r\n \"origin\": \"\",\r\n \"time\": \"2026-08-06 11:20:00\"\r\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) Your unique client key.", "key": "Client-Key", "value": "{{clientKey}}" }, { "description": "(Required) Your unique subscription key.", "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}" } ], "url": { "raw": "{{baseUrl}}/companies/:companyID/progenitors/:progenitorID", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "progenitors", ":progenitorID" ], "variable": [ { "key": "companyID" }, { "key": "progenitorID" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\r\n \"success\": false,\r\n \"data\": [\r\n {\r\n \"code\": 111402,\r\n \"message\": \"Company ID is not valid.\",\r\n \"details\": \"\",\r\n \"element\": \"companyID\"\r\n }\r\n ],\r\n \"extended\": \"\",\r\n \"meta\": \"\",\r\n \"origin\": \"\",\r\n \"time\": \"2026-08-06 11:20:30\"\r\n}" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) Your unique client key.", "key": "Client-Key", "value": "{{clientKey}}" }, { "description": "(Required) Your unique subscription key.", "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}" } ], "url": { "raw": "{{baseUrl}}/companies/:companyID/progenitors/:progenitorID", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "progenitors", ":progenitorID" ], "variable": [ { "key": "companyID" }, { "key": "progenitorID" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\r\n \"success\": false,\r\n \"data\": [\r\n {\r\n \"code\": 511401,\r\n \"message\": \"Progenitor ID not found.\",\r\n \"details\": \"\",\r\n \"element\": \"progenitorID\"\r\n }\r\n ],\r\n \"extended\": \"\",\r\n \"meta\": \"\",\r\n \"origin\": \"\",\r\n \"time\": \"2026-08-06 11:21:00\"\r\n}" }, { "name": "Internal Server Error", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) Your unique client key.", "key": "Client-Key", "value": "{{clientKey}}" }, { "description": "(Required) Your unique subscription key.", "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}" } ], "url": { "raw": "{{baseUrl}}/companies/:companyID/progenitors/:progenitorID", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "progenitors", ":progenitorID" ], "variable": [ { "key": "companyID" }, { "key": "progenitorID" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\r\n \"success\": false,\r\n \"data\": [\r\n {\r\n \"code\": 1009220,\r\n \"message\": \"Database operation failed.\",\r\n \"details\": \"\",\r\n \"element\": \"\"\r\n }\r\n ],\r\n \"extended\": \"\",\r\n \"meta\": \"\",\r\n \"origin\": \"\",\r\n \"time\": \"2026-08-06 11:21:30\"\r\n}" } ] }, { "name": "Retrieve all progenitors", "request": { "method": "GET", "header": [ { "description": "(Required) Your unique client key.", "key": "Client-Key", "value": "{{clientKey}}" }, { "description": "(Required) Your unique subscription key.", "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}" } ], "url": { "raw": "{{baseUrl}}/companies/:companyID/progenitors", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "progenitors" ], "variable": [ { "key": "companyID", "value": "1", "description": "(Required) The company's unique ID." } ] }, "description": "Retrieve all progenitors." }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) Your unique client key.", "key": "Client-Key", "value": "{{clientKey}}" }, { "description": "(Required) Your unique subscription key.", "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}" } ], "url": { "raw": "{{baseUrl}}/companies/:companyID/progenitors", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "progenitors" ], "variable": [ { "key": "companyID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\r\n \"success\": true,\r\n \"data\": {\r\n \"progenitors\": [\r\n {\r\n \"progenitorID\": \"1\",\r\n \"startDateTime\": \"2020-01-01 00:00:00\",\r\n \"stopDateTime\": \"2020-12-31 23:59:59\",\r\n \"supplierInvoices\": true,\r\n \"customerInvoices\": true,\r\n \"receipts\": true,\r\n \"created\": \"2020-01-01 00:05:12\"\r\n },\r\n {\r\n \"progenitorID\": \"2\",\r\n \"startDateTime\": \"2020-01-01 00:00:00\",\r\n \"stopDateTime\": \"\",\r\n \"supplierInvoices\": true,\r\n \"customerInvoices\": false,\r\n \"receipts\": false,\r\n \"created\": \"2020-02-14 09:30:00\"\r\n }\r\n ]\r\n },\r\n \"extended\": \"\",\r\n \"meta\": \"\",\r\n \"origin\": \"\",\r\n \"time\": \"2026-08-06 11:00:00\"\r\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) Your unique client key.", "key": "Client-Key", "value": "{{clientKey}}" }, { "description": "(Required) Your unique subscription key.", "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}" } ], "url": { "raw": "{{baseUrl}}/companies/:companyID/progenitors", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "progenitors" ], "variable": [ { "key": "companyID" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\r\n \"success\": false,\r\n \"data\": [\r\n {\r\n \"code\": 111402,\r\n \"message\": \"Company ID is not valid.\",\r\n \"details\": \"\",\r\n \"element\": \"companyID\"\r\n }\r\n ],\r\n \"extended\": \"\",\r\n \"meta\": \"\",\r\n \"origin\": \"\",\r\n \"time\": \"2026-08-06 11:00:30\"\r\n}" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) Your unique client key.", "key": "Client-Key", "value": "{{clientKey}}" }, { "description": "(Required) Your unique subscription key.", "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}" } ], "url": { "raw": "{{baseUrl}}/companies/:companyID/progenitors", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "progenitors" ], "variable": [ { "key": "companyID" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\r\n \"success\": false,\r\n \"data\": [\r\n {\r\n \"code\": 111401,\r\n \"message\": \"Company ID not found.\",\r\n \"details\": \"\",\r\n \"element\": \"companyID\"\r\n }\r\n ],\r\n \"extended\": \"\",\r\n \"meta\": \"\",\r\n \"origin\": \"\",\r\n \"time\": \"2026-08-06 11:01:00\"\r\n}" }, { "name": "Internal Server Error", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) Your unique client key.", "key": "Client-Key", "value": "{{clientKey}}" }, { "description": "(Required) Your unique subscription key.", "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}" } ], "url": { "raw": "{{baseUrl}}/companies/:companyID/progenitors", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "progenitors" ], "variable": [ { "key": "companyID" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\r\n \"success\": false,\r\n \"data\": [\r\n {\r\n \"code\": 1009220,\r\n \"message\": \"Database operation failed.\",\r\n \"details\": \"\",\r\n \"element\": \"\"\r\n }\r\n ],\r\n \"extended\": \"\",\r\n \"meta\": \"\",\r\n \"origin\": \"\",\r\n \"time\": \"2026-08-06 11:01:30\"\r\n}" } ] }, { "name": "Update a progenitor", "request": { "method": "PUT", "header": [ { "description": "(Required) Your unique client key.", "key": "Client-Key", "value": "{{clientKey}}" }, { "description": "(Required) Your unique subscription key.", "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\r\n \"progenitorID\": \"c1\",\r\n \"startDateTime\": \"2020-01-01 00:00:00\",\r\n \"stopDateTime\": \"2020-12-31 23:59:59\",\r\n \"supplierInvoices\": true,\r\n \"customerInvoices\": true,\r\n \"receipts\": true\r\n}" }, "url": { "raw": "{{baseUrl}}/companies/:companyID/progenitors/:progenitorID", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "progenitors", ":progenitorID" ], "variable": [ { "key": "companyID", "value": "1", "description": "(Required) The company's unique ID." }, { "key": "progenitorID", "value": "c1", "description": "(Required) The progenitor's unique ID." } ] }, "description": "Update a progenitor." }, "response": [ { "name": "OK", "originalRequest": { "method": "PUT", "header": [ { "description": "(Required) Your unique client key.", "key": "Client-Key", "value": "{{clientKey}}" }, { "description": "(Required) Your unique subscription key.", "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}" } ], "body": { "mode": "raw", "raw": "{\n \"progenitorID\": \"c1\",\n \"startDateTime\": \"2020-01-01 00:00:00\",\n \"stopDateTime\": \"2020-12-31 23:59:59\",\n \"supplierInvoices\": true,\n \"receipts\": true\n}" }, "url": { "raw": "{{baseUrl}}/companies/:companyID/progenitors/:progenitorID", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "progenitors", ":progenitorID" ], "variable": [ { "key": "companyID" }, { "key": "progenitorID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\r\n \"success\": true,\r\n \"data\": {\r\n \"progenitorID\": \"c1\",\r\n \"startDateTime\": \"2020-01-01 00:00:00\",\r\n \"stopDateTime\": \"2020-12-31 23:59:59\",\r\n \"supplierInvoices\": true,\r\n \"customerInvoices\": true,\r\n \"receipts\": true\r\n },\r\n \"extended\": \"\",\r\n \"meta\": \"\",\r\n \"origin\": \"\",\r\n \"time\": \"2026-08-06 11:30:00\"\r\n}" }, { "name": "Bad Request", "originalRequest": { "method": "PUT", "header": [ { "description": "(Required) Your unique client key.", "key": "Client-Key", "value": "{{clientKey}}" }, { "description": "(Required) Your unique subscription key.", "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}" } ], "body": { "mode": "raw", "raw": "{\n \"progenitorID\": \"c1\",\n \"startDateTime\": \"2020-01-01 00:00:00\",\n \"stopDateTime\": \"2020-12-31 23:59:59\",\n \"supplierInvoices\": true,\n \"receipts\": true\n}" }, "url": { "raw": "{{baseUrl}}/companies/:companyID/progenitors/:progenitorID", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "progenitors", ":progenitorID" ], "variable": [ { "key": "companyID" }, { "key": "progenitorID" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\r\n \"success\": false,\r\n \"data\": [\r\n {\r\n \"code\": 111402,\r\n \"message\": \"Company ID is not valid.\",\r\n \"details\": \"Both progenitor IDs need to be the same company ID.\",\r\n \"element\": \"progenitorID\"\r\n }\r\n ],\r\n \"extended\": \"\",\r\n \"meta\": \"\",\r\n \"origin\": \"\",\r\n \"time\": \"2026-08-06 11:30:30\"\r\n}" }, { "name": "Not Found", "originalRequest": { "method": "PUT", "header": [ { "description": "(Required) Your unique client key.", "key": "Client-Key", "value": "{{clientKey}}" }, { "description": "(Required) Your unique subscription key.", "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}" } ], "body": { "mode": "raw", "raw": "{\n \"progenitorID\": \"c1\",\n \"startDateTime\": \"2020-01-01 00:00:00\",\n \"stopDateTime\": \"2020-12-31 23:59:59\",\n \"supplierInvoices\": true,\n \"receipts\": true\n}" }, "url": { "raw": "{{baseUrl}}/companies/:companyID/progenitors/:progenitorID", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "progenitors", ":progenitorID" ], "variable": [ { "key": "companyID" }, { "key": "progenitorID" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\r\n \"success\": false,\r\n \"data\": [\r\n {\r\n \"code\": 511401,\r\n \"message\": \"Progenitor ID not found.\",\r\n \"details\": \"\",\r\n \"element\": \"progenitorID\"\r\n }\r\n ],\r\n \"extended\": \"\",\r\n \"meta\": \"\",\r\n \"origin\": \"\",\r\n \"time\": \"2026-08-06 11:31:00\"\r\n}" }, { "name": "Internal Server Error", "originalRequest": { "method": "PUT", "header": [ { "description": "(Required) Your unique client key.", "key": "Client-Key", "value": "{{clientKey}}" }, { "description": "(Required) Your unique subscription key.", "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}" } ], "body": { "mode": "raw", "raw": "{\n \"progenitorID\": \"c1\",\n \"startDateTime\": \"2020-01-01 00:00:00\",\n \"stopDateTime\": \"2020-12-31 23:59:59\",\n \"supplierInvoices\": true,\n \"receipts\": true\n}" }, "url": { "raw": "{{baseUrl}}/companies/:companyID/progenitors/:progenitorID", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "progenitors", ":progenitorID" ], "variable": [ { "key": "companyID" }, { "key": "progenitorID" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\r\n \"success\": false,\r\n \"data\": [\r\n {\r\n \"code\": 1009220,\r\n \"message\": \"Database operation failed.\",\r\n \"details\": \"\",\r\n \"element\": \"\"\r\n }\r\n ],\r\n \"extended\": \"\",\r\n \"meta\": \"\",\r\n \"origin\": \"\",\r\n \"time\": \"2026-08-06 11:31:30\"\r\n}" } ] }, { "name": "Delete a progenitor", "request": { "method": "DELETE", "header": [ { "description": "(Required) Your unique client key.", "key": "Client-Key", "value": "{{clientKey}}" }, { "description": "(Required) Your unique subscription key.", "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}" } ], "url": { "raw": "{{baseUrl}}/companies/:companyID/progenitors/:progenitorID", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "progenitors", ":progenitorID" ], "variable": [ { "key": "companyID", "value": "1", "description": "(Required) The company's unique ID." }, { "key": "progenitorID", "value": "c1", "description": "(Required) The progenitor's unique ID." } ] }, "description": "Delete a progenitor." }, "response": [ { "name": "OK", "originalRequest": { "method": "DELETE", "header": [ { "description": "(Required) Your unique client key.", "key": "Client-Key", "value": "{{clientKey}}" }, { "description": "(Required) Your unique subscription key.", "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}" } ], "url": { "raw": "{{baseUrl}}/companies/:companyID/progenitors/:progenitorID", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "progenitors", ":progenitorID" ], "variable": [ { "key": "companyID" }, { "key": "progenitorID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\r\n \"success\": true,\r\n \"data\": {},\r\n \"extended\": \"\",\r\n \"meta\": \"\",\r\n \"origin\": \"\",\r\n \"time\": \"2026-08-06 11:40:00\"\r\n}" }, { "name": "Bad Request", "originalRequest": { "method": "DELETE", "header": [ { "description": "(Required) Your unique client key.", "key": "Client-Key", "value": "{{clientKey}}" }, { "description": "(Required) Your unique subscription key.", "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}" } ], "url": { "raw": "{{baseUrl}}/companies/:companyID/progenitors/:progenitorID", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "progenitors", ":progenitorID" ], "variable": [ { "key": "companyID" }, { "key": "progenitorID" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\r\n \"success\": false,\r\n \"data\": [\r\n {\r\n \"code\": 111402,\r\n \"message\": \"Company ID is not valid.\",\r\n \"details\": \"\",\r\n \"element\": \"companyID\"\r\n }\r\n ],\r\n \"extended\": \"\",\r\n \"meta\": \"\",\r\n \"origin\": \"\",\r\n \"time\": \"2026-08-06 11:40:30\"\r\n}" }, { "name": "Not Found", "originalRequest": { "method": "DELETE", "header": [ { "description": "(Required) Your unique client key.", "key": "Client-Key", "value": "{{clientKey}}" }, { "description": "(Required) Your unique subscription key.", "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}" } ], "url": { "raw": "{{baseUrl}}/companies/:companyID/progenitors/:progenitorID", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "progenitors", ":progenitorID" ], "variable": [ { "key": "companyID" }, { "key": "progenitorID" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\r\n \"success\": false,\r\n \"data\": [\r\n {\r\n \"code\": 511401,\r\n \"message\": \"Progenitor ID not found.\",\r\n \"details\": \"\",\r\n \"element\": \"progenitorID\"\r\n }\r\n ],\r\n \"extended\": \"\",\r\n \"meta\": \"\",\r\n \"origin\": \"\",\r\n \"time\": \"2026-08-06 11:41:00\"\r\n}" }, { "name": "Internal Server Error", "originalRequest": { "method": "DELETE", "header": [ { "description": "(Required) Your unique client key.", "key": "Client-Key", "value": "{{clientKey}}" }, { "description": "(Required) Your unique subscription key.", "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}" } ], "url": { "raw": "{{baseUrl}}/companies/:companyID/progenitors/:progenitorID", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "progenitors", ":progenitorID" ], "variable": [ { "key": "companyID" }, { "key": "progenitorID" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\r\n \"success\": false,\r\n \"data\": [\r\n {\r\n \"code\": 1009220,\r\n \"message\": \"Database operation failed.\",\r\n \"details\": \"\",\r\n \"element\": \"\"\r\n }\r\n ],\r\n \"extended\": \"\",\r\n \"meta\": \"\",\r\n \"origin\": \"\",\r\n \"time\": \"2026-08-06 11:41:30\"\r\n}" } ] } ] }, { "name": "Memories", "item": [ { "name": "Delete all memories", "request": { "method": "DELETE", "header": [ { "description": "(Required) Your unique client key.", "key": "Client-Key", "value": "{{clientKey}}" }, { "description": "(Required) Your unique subscription key.", "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}" } ], "url": { "raw": "{{baseUrl}}/companies/:companyID/memories", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "memories" ], "variable": [ { "key": "companyID", "value": "1", "description": "(Required) The company's unique ID." } ] }, "description": "Delete all memories." }, "response": [ { "name": "OK", "originalRequest": { "method": "DELETE", "header": [ { "description": "(Required) Your unique client key.", "key": "Client-Key", "value": "{{clientKey}}" }, { "description": "(Required) Your unique subscription key.", "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}" } ], "url": { "raw": "{{baseUrl}}/companies/:companyID/memories", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "memories" ], "variable": [ { "key": "companyID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\r\n \"success\": true,\r\n \"data\": {},\r\n \"extended\": \"\",\r\n \"meta\": \"\",\r\n \"origin\": \"\",\r\n \"time\": \"2026-08-06 11:50:00\"\r\n}" }, { "name": "Bad Request", "originalRequest": { "method": "DELETE", "header": [ { "description": "(Required) Your unique client key.", "key": "Client-Key", "value": "{{clientKey}}" }, { "description": "(Required) Your unique subscription key.", "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}" } ], "url": { "raw": "{{baseUrl}}/companies/:companyID/memories", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "memories" ], "variable": [ { "key": "companyID" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\r\n \"success\": false,\r\n \"data\": [\r\n {\r\n \"code\": 111402,\r\n \"message\": \"Company ID is not valid.\",\r\n \"details\": \"\",\r\n \"element\": \"companyID\"\r\n }\r\n ],\r\n \"extended\": \"\",\r\n \"meta\": \"\",\r\n \"origin\": \"\",\r\n \"time\": \"2026-08-06 11:50:30\"\r\n}" }, { "name": "Not Found", "originalRequest": { "method": "DELETE", "header": [ { "description": "(Required) Your unique client key.", "key": "Client-Key", "value": "{{clientKey}}" }, { "description": "(Required) Your unique subscription key.", "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}" } ], "url": { "raw": "{{baseUrl}}/companies/:companyID/memories", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "memories" ], "variable": [ { "key": "companyID" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\r\n \"success\": false,\r\n \"data\": [\r\n {\r\n \"code\": 111401,\r\n \"message\": \"Company ID not found.\",\r\n \"details\": \"\",\r\n \"element\": \"companyID\"\r\n }\r\n ],\r\n \"extended\": \"\",\r\n \"meta\": \"\",\r\n \"origin\": \"\",\r\n \"time\": \"2026-08-06 11:51:00\"\r\n}" }, { "name": "Internal Server Error", "originalRequest": { "method": "DELETE", "header": [ { "description": "(Required) Your unique client key.", "key": "Client-Key", "value": "{{clientKey}}" }, { "description": "(Required) Your unique subscription key.", "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}" } ], "url": { "raw": "{{baseUrl}}/companies/:companyID/memories", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "memories" ], "variable": [ { "key": "companyID" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\r\n \"success\": false,\r\n \"data\": [\r\n {\r\n \"code\": 1009220,\r\n \"message\": \"Database operation failed.\",\r\n \"details\": \"\",\r\n \"element\": \"\"\r\n }\r\n ],\r\n \"extended\": \"\",\r\n \"meta\": \"\",\r\n \"origin\": \"\",\r\n \"time\": \"2026-08-06 11:51:30\"\r\n}" } ] } ] }, { "name": "Models", "item": [ { "name": "Update models status", "request": { "method": "PATCH", "header": [ { "key": "Client-Key", "value": "{{clientKey}}", "description": "(Required) Your unique client key." }, { "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}", "description": "(Required) Your unique subscription key." }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\r\n \"active\": false\r\n}" }, "url": { "raw": "{{baseUrl}}/companies/:companyID/models?type&supplierID&startDateTime&endDateTime", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "models" ], "query": [ { "key": "type", "value": null }, { "key": "supplierID", "value": null }, { "key": "startDateTime", "value": null }, { "key": "endDateTime", "value": null } ], "variable": [ { "key": "companyID", "value": "" } ] }, "description": "Update a company." }, "response": [ { "name": "OK", "originalRequest": { "method": "PATCH", "header": [ { "key": "Client-Key", "value": "{{clientKey}}", "description": "(Required) Your unique client key." }, { "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}", "description": "(Required) Your unique subscription key." }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"active\": false\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/companies/:companyID/models?type&supplierID&startDateTime&endDateTime", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "models" ], "query": [ { "key": "type", "value": null }, { "key": "supplierID", "value": null }, { "key": "startDateTime", "value": null }, { "key": "endDateTime", "value": null } ], "variable": [ { "key": "companyID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\r\n \"success\": true,\r\n \"data\": {\r\n \"active\": false\r\n },\r\n \"extended\": \"\",\r\n \"meta\": \"\",\r\n \"origin\": \"\",\r\n \"time\": \"2026-08-06 10:40:00\"\r\n}" }, { "name": "Bad Request", "originalRequest": { "method": "PATCH", "header": [ { "key": "Client-Key", "value": "{{clientKey}}", "description": "(Required) Your unique client key." }, { "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}", "description": "(Required) Your unique subscription key." }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"active\": false\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/companies/:companyID/models?type&supplierID&startDateTime&endDateTime", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "models" ], "query": [ { "key": "type", "value": null }, { "key": "supplierID", "value": null }, { "key": "startDateTime", "value": null }, { "key": "endDateTime", "value": null } ], "variable": [ { "key": "companyID" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\r\n \"success\": false,\r\n \"data\": [\r\n {\r\n \"code\": 911901,\r\n \"message\": \"Type does not exist.\",\r\n \"details\": \"The type value must be either 'SupplierInvoice', 'Receipt'.\",\r\n \"element\": \"type\"\r\n }\r\n ],\r\n \"extended\": \"\",\r\n \"meta\": \"\",\r\n \"origin\": \"\",\r\n \"time\": \"2026-08-06 10:40:30\"\r\n}" }, { "name": "Not Found", "originalRequest": { "method": "PATCH", "header": [ { "key": "Client-Key", "value": "{{clientKey}}", "description": "(Required) Your unique client key." }, { "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}", "description": "(Required) Your unique subscription key." }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"active\": false\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/companies/:companyID/models?type&supplierID&startDateTime&endDateTime", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "models" ], "query": [ { "key": "type", "value": null }, { "key": "supplierID", "value": null }, { "key": "startDateTime", "value": null }, { "key": "endDateTime", "value": null } ], "variable": [ { "key": "companyID" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\r\n \"success\": false,\r\n \"data\": [\r\n {\r\n \"code\": 111401,\r\n \"message\": \"Company ID not found.\",\r\n \"details\": \"\",\r\n \"element\": \"companyID\"\r\n }\r\n ],\r\n \"extended\": \"\",\r\n \"meta\": \"\",\r\n \"origin\": \"\",\r\n \"time\": \"2026-08-06 10:41:00\"\r\n}" }, { "name": "Internal Server Error", "originalRequest": { "method": "PATCH", "header": [ { "key": "Client-Key", "value": "{{clientKey}}", "description": "(Required) Your unique client key." }, { "key": "Ocp-Apim-Subscription-Key", "value": "{{subscriptionKey}}", "description": "(Required) Your unique subscription key." }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"active\": false\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/companies/:companyID/models?type&supplierID&startDateTime&endDateTime", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyID", "models" ], "query": [ { "key": "type", "value": null }, { "key": "supplierID", "value": null }, { "key": "startDateTime", "value": null }, { "key": "endDateTime", "value": null } ], "variable": [ { "key": "companyID" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\r\n \"success\": false,\r\n \"data\": [\r\n {\r\n \"code\": 1009220,\r\n \"message\": \"Database operation failed.\",\r\n \"details\": \"\",\r\n \"element\": \"\"\r\n }\r\n ],\r\n \"extended\": \"\",\r\n \"meta\": \"\",\r\n \"origin\": \"\",\r\n \"time\": \"2026-08-06 10:41:30\"\r\n}" } ] } ] } ], "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "" ] } }, { "listen": "test", "script": { "type": "text/javascript", "exec": [ "" ] } } ], "variable": [ { "key": "baseUrl", "value": "YOUR_BASE_URL" }, { "key": "clientKey", "value": "YOUR_CLIENT_KEY" }, { "key": "subscriptionKey", "value": "YOUR_SUBSCRIPTION_KEY" } ] }