{ "info": { "_postman_id": "ec9c074e-ff46-4dde-b978-e964c16c9a34", "name": "Semine.IntegrationApi.Api", "description": "The Semine integration API offer support for integration between Semine and external systems, to support invoice and purchase order processing in Semine. Objects for integration are typically suppliers and accounting parameters like dimensions, accounting codes, VAT codes and fixed assets, in addition to getting invoices ready for posting and the ability to set invoices in Semine as posted.\n\nContact Support:\n Email: apisupport@semine.no", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" }, "item": [ { "name": "Start", "item": [ { "name": "/connect/token", "event": [ { "listen": "test", "script": { "exec": [ "pm.environment.set(\"Token\", pm.response.json().access_token);" ], "type": "text/javascript" } } ], "request": { "auth": { "type": "basic", "basic": [ { "key": "password", "value": "{{Oauth2ClientSecret}}", "type": "string" }, { "key": "username", "value": "{{Oauth2ClientId}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "name": "Content-Type", "type": "text", "value": "application/json" } ], "body": { "mode": "formdata", "formdata": [ { "key": "grant_type", "value": "password", "type": "text" }, { "key": "scope", "value": "invoiceservice", "type": "text" }, { "key": "username", "value": "{{Username}}", "type": "text" }, { "key": "password", "value": "{{Password}}", "type": "text" } ] }, "url": { "raw": "https://login.testsemine.no/connect/token", "protocol": "https", "host": [ "login", "testsemine", "no" ], "path": [ "connect", "token" ] } }, "response": [] } ] }, { "name": "api/v1.0", "item": [ { "name": "organizations", "item": [ { "name": "{organization Id}", "item": [ { "name": "clients", "item": [ { "name": "{client Id}", "item": [ { "name": "accountingcodes", "item": [ { "name": "{code}", "item": [ { "name": "/accountingcodes/:code", "request": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/accountingcodes/:code", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "accountingcodes", ":code" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization id of the organization to which the accounting code is related." }, { "key": "clientId", "value": "", "description": "(Required) Client id of the client to which the accounting code is related." }, { "key": "code", "value": "", "description": "(Required) The unique code for the accounting code" } ] }, "description": "Gets an accounting code based on the ERP code." }, "response": [ { "name": "Validation of model fails.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/accountingcodes/:code", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "accountingcodes", ":code" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" }, { "key": "code" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Accounting code does not exist.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/accountingcodes/:code", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "accountingcodes", ":code" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" }, { "key": "code" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "The accounting code for the given client with requested code", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/accountingcodes/:code", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "accountingcodes", ":code" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" }, { "key": "code" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"\",\n \"status\": \"\",\n \"relations\": [\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n },\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n }\n ],\n \"description\": [\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n },\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n }\n ]\n}" }, { "name": "If user doesn't have permission to access this resource.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/accountingcodes/:code", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "accountingcodes", ":code" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" }, { "key": "code" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "If any network or client related error occurs.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/accountingcodes/:code", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "accountingcodes", ":code" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" }, { "key": "code" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\"\n}" }, { "name": "If security token is not provided or user not authenticated.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/accountingcodes/:code", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "accountingcodes", ":code" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" }, { "key": "code" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] }, { "name": "/accountingcodes/:code", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/accountingcodes/:code", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "accountingcodes", ":code" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization id of the organization to which the accounting code is related." }, { "key": "clientId", "value": "", "description": "(Required) Client id of the client to which the accounting code is related." }, { "key": "code", "value": "", "description": "(Required) The unique code of the accounting code to delete" } ] }, "description": "Delete an accounting code" }, "response": [ { "name": "If any network or client related error occurs.", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/accountingcodes/:code", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "accountingcodes", ":code" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" }, { "key": "code" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\"\n}" }, { "name": "The accounting code has been deleted successfully", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/accountingcodes/:code", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "accountingcodes", ":code" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" }, { "key": "code" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"\",\n \"status\": \"\",\n \"relations\": [\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n },\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n }\n ],\n \"description\": [\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n },\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n }\n ]\n}" }, { "name": "The accounting code can not be found.", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/accountingcodes/:code", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "accountingcodes", ":code" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" }, { "key": "code" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "If security token is not provided or user not authenticated.", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/accountingcodes/:code", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "accountingcodes", ":code" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" }, { "key": "code" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Validation of model fails.", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/accountingcodes/:code", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "accountingcodes", ":code" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" }, { "key": "code" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "If user doesn't have permission to access this resource.", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/accountingcodes/:code", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "accountingcodes", ":code" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" }, { "key": "code" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] } ] }, { "name": "/accountingcodes", "request": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/accountingcodes?textSearch=", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "accountingcodes" ], "query": [ { "key": "textSearch", "value": "", "description": "Optional search for text in codes or descriptions" } ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization id of the organization to which the accounting codes are related." }, { "key": "clientId", "value": "", "description": "(Required) Client id of the client to which the accounting codes are related." } ] }, "description": "Gets all accounting codes for a client." }, "response": [ { "name": "If user doesn't have permission to access this resource.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/accountingcodes?textSearch=", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "accountingcodes" ], "query": [ { "key": "textSearch", "value": "" } ], "variable": [ { "key": "organizationId" }, { "key": "clientId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Validation of model fails.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/accountingcodes?textSearch=", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "accountingcodes" ], "query": [ { "key": "textSearch", "value": "" } ], "variable": [ { "key": "organizationId" }, { "key": "clientId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "If security token is not provided or user not authenticated.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/accountingcodes?textSearch=", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "accountingcodes" ], "query": [ { "key": "textSearch", "value": "" } ], "variable": [ { "key": "organizationId" }, { "key": "clientId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "If any network or client related error occurs.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/accountingcodes?textSearch=", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "accountingcodes" ], "query": [ { "key": "textSearch", "value": "" } ], "variable": [ { "key": "organizationId" }, { "key": "clientId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\"\n}" }, { "name": "No accounting codes exist for the given client", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/accountingcodes?textSearch=", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "accountingcodes" ], "query": [ { "key": "textSearch", "value": "" } ], "variable": [ { "key": "organizationId" }, { "key": "clientId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "The accounting codes for the given client", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/accountingcodes?textSearch=", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "accountingcodes" ], "query": [ { "key": "textSearch", "value": "" } ], "variable": [ { "key": "organizationId" }, { "key": "clientId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"code\": \"\",\n \"status\": \"\",\n \"relations\": [\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n },\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n }\n ],\n \"description\": [\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n },\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n }\n ]\n },\n {\n \"code\": \"\",\n \"status\": \"\",\n \"relations\": [\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n },\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n }\n ],\n \"description\": [\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n },\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n }\n ]\n }\n]" } ] }, { "name": "/accountingcodes", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "[\n {\n \"code\": \"\",\n \"status\": \"\",\n \"relations\": [\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n },\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n }\n ],\n \"description\": [\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n },\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n }\n ]\n },\n {\n \"code\": \"\",\n \"status\": \"\",\n \"relations\": [\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n },\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n }\n ],\n \"description\": [\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n },\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n }\n ]\n }\n]" }, "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/accountingcodes", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "accountingcodes" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization id of the organization to which the accounting codes are related." }, { "key": "clientId", "value": "", "description": "(Required) Client id of the client to which the accounting codes are related." } ] }, "description": "Inserts and updates accounting codes for a given client." }, "response": [ { "name": "If security token is not provided or user not authenticated.", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "[\n {\n \"code\": \"\",\n \"status\": \"\",\n \"relations\": [\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n },\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n }\n ],\n \"description\": [\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n },\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n }\n ]\n },\n {\n \"code\": \"\",\n \"status\": \"\",\n \"relations\": [\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n },\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n }\n ],\n \"description\": [\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n },\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n }\n ]\n }\n]" }, "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/accountingcodes", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "accountingcodes" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "If any network or client related error occurs.", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "[\n {\n \"code\": \"\",\n \"status\": \"\",\n \"relations\": [\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n },\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n }\n ],\n \"description\": [\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n },\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n }\n ]\n },\n {\n \"code\": \"\",\n \"status\": \"\",\n \"relations\": [\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n },\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n }\n ],\n \"description\": [\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n },\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n }\n ]\n }\n]" }, "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/accountingcodes", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "accountingcodes" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\"\n}" }, { "name": "Validation of model fails.", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "[\n {\n \"code\": \"\",\n \"status\": \"\",\n \"relations\": [\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n },\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n }\n ],\n \"description\": [\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n },\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n }\n ]\n },\n {\n \"code\": \"\",\n \"status\": \"\",\n \"relations\": [\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n },\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n }\n ],\n \"description\": [\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n },\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n }\n ]\n }\n]" }, "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/accountingcodes", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "accountingcodes" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "The accounting codes have been processed successfully", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "[\n {\n \"code\": \"\",\n \"status\": \"\",\n \"relations\": [\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n },\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n }\n ],\n \"description\": [\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n },\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n }\n ]\n },\n {\n \"code\": \"\",\n \"status\": \"\",\n \"relations\": [\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n },\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n }\n ],\n \"description\": [\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n },\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n }\n ]\n }\n]" }, "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/accountingcodes", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "accountingcodes" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"failed\": [\n {\n \"item\": {\n \"code\": \"\",\n \"status\": \"\",\n \"relations\": [\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n },\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n }\n ],\n \"description\": [\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n },\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n }\n ]\n },\n \"message\": \"\"\n },\n {\n \"item\": {\n \"code\": \"\",\n \"status\": \"\",\n \"relations\": [\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n },\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n }\n ],\n \"description\": [\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n },\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n }\n ]\n },\n \"message\": \"\"\n }\n ]\n}" }, { "name": "The parent accounting code could not be found.", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "[\n {\n \"code\": \"\",\n \"status\": \"\",\n \"relations\": [\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n },\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n }\n ],\n \"description\": [\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n },\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n }\n ]\n },\n {\n \"code\": \"\",\n \"status\": \"\",\n \"relations\": [\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n },\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n }\n ],\n \"description\": [\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n },\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n }\n ]\n }\n]" }, "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/accountingcodes", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "accountingcodes" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "If user doesn't have permission to access this resource.", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "[\n {\n \"code\": \"\",\n \"status\": \"\",\n \"relations\": [\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n },\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n }\n ],\n \"description\": [\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n },\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n }\n ]\n },\n {\n \"code\": \"\",\n \"status\": \"\",\n \"relations\": [\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n },\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n }\n ],\n \"description\": [\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n },\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n }\n ]\n }\n]" }, "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/accountingcodes", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "accountingcodes" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] }, { "name": "/accountingcodes Minimum", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "[\n {\n \"code\": \"\",\n \"status\": \"\",\n \"relations\": [\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n },\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n }\n ],\n \"description\": [\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n },\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n }\n ]\n },\n {\n \"code\": \"\",\n \"status\": \"\",\n \"relations\": [\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n },\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n }\n ],\n \"description\": [\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n },\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n }\n ]\n }\n]" }, "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/accountingcodes", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "accountingcodes" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization id of the organization to which the accounting codes are related." }, { "key": "clientId", "value": "", "description": "(Required) Client id of the client to which the accounting codes are related." } ] }, "description": "Inserts and updates accounting codes for a given client." }, "response": [ { "name": "The accounting codes have been processed successfully", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "[\n {\n \"code\": \"\",\n \"status\": \"\",\n \"relations\": [\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n },\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n }\n ],\n \"description\": [\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n },\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n }\n ]\n },\n {\n \"code\": \"\",\n \"status\": \"\",\n \"relations\": [\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n },\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n }\n ],\n \"description\": [\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n },\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n }\n ]\n }\n]" }, "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/accountingcodes", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "accountingcodes" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"failed\": [\n {\n \"item\": {\n \"code\": \"\",\n \"status\": \"\",\n \"relations\": [\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n },\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n }\n ],\n \"description\": [\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n },\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n }\n ]\n },\n \"message\": \"\"\n },\n {\n \"item\": {\n \"code\": \"\",\n \"status\": \"\",\n \"relations\": [\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n },\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n }\n ],\n \"description\": [\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n },\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n }\n ]\n },\n \"message\": \"\"\n }\n ]\n}" }, { "name": "If any network or client related error occurs.", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "[\n {\n \"code\": \"\",\n \"status\": \"\",\n \"relations\": [\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n },\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n }\n ],\n \"description\": [\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n },\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n }\n ]\n },\n {\n \"code\": \"\",\n \"status\": \"\",\n \"relations\": [\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n },\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n }\n ],\n \"description\": [\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n },\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n }\n ]\n }\n]" }, "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/accountingcodes", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "accountingcodes" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\"\n}" }, { "name": "The parent accounting code could not be found.", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "[\n {\n \"code\": \"\",\n \"status\": \"\",\n \"relations\": [\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n },\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n }\n ],\n \"description\": [\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n },\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n }\n ]\n },\n {\n \"code\": \"\",\n \"status\": \"\",\n \"relations\": [\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n },\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n }\n ],\n \"description\": [\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n },\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n }\n ]\n }\n]" }, "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/accountingcodes", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "accountingcodes" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "If user doesn't have permission to access this resource.", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "[\n {\n \"code\": \"\",\n \"status\": \"\",\n \"relations\": [\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n },\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n }\n ],\n \"description\": [\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n },\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n }\n ]\n },\n {\n \"code\": \"\",\n \"status\": \"\",\n \"relations\": [\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n },\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n }\n ],\n \"description\": [\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n },\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n }\n ]\n }\n]" }, "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/accountingcodes", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "accountingcodes" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Validation of model fails.", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "[\n {\n \"code\": \"\",\n \"status\": \"\",\n \"relations\": [\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n },\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n }\n ],\n \"description\": [\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n },\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n }\n ]\n },\n {\n \"code\": \"\",\n \"status\": \"\",\n \"relations\": [\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n },\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n }\n ],\n \"description\": [\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n },\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n }\n ]\n }\n]" }, "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/accountingcodes", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "accountingcodes" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "If security token is not provided or user not authenticated.", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "[\n {\n \"code\": \"\",\n \"status\": \"\",\n \"relations\": [\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n },\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n }\n ],\n \"description\": [\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n },\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n }\n ]\n },\n {\n \"code\": \"\",\n \"status\": \"\",\n \"relations\": [\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n },\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n }\n ],\n \"description\": [\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n },\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n }\n ]\n }\n]" }, "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/accountingcodes", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "accountingcodes" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] } ] }, { "name": "categorytypes", "item": [ { "name": "{code}", "item": [ { "name": "/categorytypes/:code", "request": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/categorytypes/:code", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "categorytypes", ":code" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization id of the organization to which the category type is related." }, { "key": "clientId", "value": "", "description": "(Required) Client id of the client to which the category type is related." }, { "key": "code", "value": "", "description": "(Required) The ERP code for the category type" } ] }, "description": "Gets a category type based on the ERP code." }, "response": [ { "name": "If any network or client related error occurs.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/categorytypes/:code", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "categorytypes", ":code" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" }, { "key": "code" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\"\n}" }, { "name": "Validation of model fails.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/categorytypes/:code", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "categorytypes", ":code" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" }, { "key": "code" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Category type does not exist.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/categorytypes/:code", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "categorytypes", ":code" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" }, { "key": "code" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "If user doesn't have permission to access this resource.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/categorytypes/:code", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "categorytypes", ":code" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" }, { "key": "code" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "The category type for the given client with requested code", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/categorytypes/:code", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "categorytypes", ":code" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" }, { "key": "code" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"\",\n \"status\": \"\",\n \"description\": [\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n },\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n }\n ]\n}" }, { "name": "If security token is not provided or user not authenticated.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/categorytypes/:code", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "categorytypes", ":code" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" }, { "key": "code" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] }, { "name": "/categorytypes/:code", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/categorytypes/:code", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "categorytypes", ":code" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization id of the organization to which the category type is related." }, { "key": "clientId", "value": "", "description": "(Required) Client id of the client to which the category type is related." }, { "key": "code", "value": "", "description": "(Required) The ERP code of the category type to delete" } ] }, "description": "Delete a category type" }, "response": [ { "name": "If security token is not provided or user not authenticated.", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/categorytypes/:code", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "categorytypes", ":code" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" }, { "key": "code" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Validation of model fails.", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/categorytypes/:code", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "categorytypes", ":code" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" }, { "key": "code" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "The category type has been deleted successfully", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/categorytypes/:code", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "categorytypes", ":code" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" }, { "key": "code" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"\",\n \"status\": \"\",\n \"description\": [\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n },\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n }\n ]\n}" }, { "name": "If user doesn't have permission to access this resource.", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/categorytypes/:code", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "categorytypes", ":code" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" }, { "key": "code" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "If any network or client related error occurs.", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/categorytypes/:code", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "categorytypes", ":code" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" }, { "key": "code" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\"\n}" } ] } ] }, { "name": "/categorytypes", "request": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/categorytypes?textSearch=", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "categorytypes" ], "query": [ { "key": "textSearch", "value": "", "description": "Optional search for text in codes or descriptions" } ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization id of the organization to which the category types are related." }, { "key": "clientId", "value": "", "description": "(Required) Client id of the client to which the category types are related." } ] }, "description": "Gets all category types for a given client." }, "response": [ { "name": "If security token is not provided or user not authenticated.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/categorytypes?textSearch=", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "categorytypes" ], "query": [ { "key": "textSearch", "value": "" } ], "variable": [ { "key": "organizationId" }, { "key": "clientId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "The category types for the given client", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/categorytypes?textSearch=", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "categorytypes" ], "query": [ { "key": "textSearch", "value": "" } ], "variable": [ { "key": "organizationId" }, { "key": "clientId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"code\": \"\",\n \"status\": \"\",\n \"description\": [\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n },\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n }\n ]\n },\n {\n \"code\": \"\",\n \"status\": \"\",\n \"description\": [\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n },\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n }\n ]\n }\n]" }, { "name": "If any network or client related error occurs.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/categorytypes?textSearch=", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "categorytypes" ], "query": [ { "key": "textSearch", "value": "" } ], "variable": [ { "key": "organizationId" }, { "key": "clientId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\"\n}" }, { "name": "Validation of model fails.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/categorytypes?textSearch=", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "categorytypes" ], "query": [ { "key": "textSearch", "value": "" } ], "variable": [ { "key": "organizationId" }, { "key": "clientId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "If user doesn't have permission to access this resource.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/categorytypes?textSearch=", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "categorytypes" ], "query": [ { "key": "textSearch", "value": "" } ], "variable": [ { "key": "organizationId" }, { "key": "clientId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "No category types exist for the given client", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/categorytypes?textSearch=", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "categorytypes" ], "query": [ { "key": "textSearch", "value": "" } ], "variable": [ { "key": "organizationId" }, { "key": "clientId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] }, { "name": "/categorytypes", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "[\n {\n \"code\": \"\",\n \"status\": \"\",\n \"description\": [\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n },\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n }\n ]\n },\n {\n \"code\": \"\",\n \"status\": \"\",\n \"description\": [\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n },\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n }\n ]\n }\n]" }, "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/categorytypes", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "categorytypes" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization id of the organizations to which the category types are related." }, { "key": "clientId", "value": "", "description": "(Required) Client id of the client to which the category types are related." } ] }, "description": "Inserts and updates category types" }, "response": [ { "name": "If security token is not provided or user not authenticated.", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "[\n {\n \"code\": \"\",\n \"status\": \"\",\n \"description\": [\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n },\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n }\n ]\n },\n {\n \"code\": \"\",\n \"status\": \"\",\n \"description\": [\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n },\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n }\n ]\n }\n]" }, "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/categorytypes", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "categorytypes" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "The category types have been processed successfully", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "[\n {\n \"code\": \"\",\n \"status\": \"\",\n \"description\": [\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n },\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n }\n ]\n },\n {\n \"code\": \"\",\n \"status\": \"\",\n \"description\": [\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n },\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n }\n ]\n }\n]" }, "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/categorytypes", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "categorytypes" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"failed\": [\n {\n \"item\": {\n \"code\": \"\",\n \"status\": \"\",\n \"description\": [\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n },\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n }\n ]\n },\n \"message\": \"\"\n },\n {\n \"item\": {\n \"code\": \"\",\n \"status\": \"\",\n \"description\": [\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n },\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n }\n ]\n },\n \"message\": \"\"\n }\n ]\n}" }, { "name": "If user doesn't have permission to access this resource.", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "[\n {\n \"code\": \"\",\n \"status\": \"\",\n \"description\": [\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n },\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n }\n ]\n },\n {\n \"code\": \"\",\n \"status\": \"\",\n \"description\": [\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n },\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n }\n ]\n }\n]" }, "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/categorytypes", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "categorytypes" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Validation of model fails.", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "[\n {\n \"code\": \"\",\n \"status\": \"\",\n \"description\": [\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n },\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n }\n ]\n },\n {\n \"code\": \"\",\n \"status\": \"\",\n \"description\": [\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n },\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n }\n ]\n }\n]" }, "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/categorytypes", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "categorytypes" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "If any network or client related error occurs.", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "[\n {\n \"code\": \"\",\n \"status\": \"\",\n \"description\": [\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n },\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n }\n ]\n },\n {\n \"code\": \"\",\n \"status\": \"\",\n \"description\": [\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n },\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n }\n ]\n }\n]" }, "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/categorytypes", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "categorytypes" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\"\n}" } ] } ] }, { "name": "currency", "item": [ { "name": "/currency", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "[\n {\n \"baseCurrency\": \"\",\n \"conversionRate\": \"\",\n \"currencyCode\": \"\",\n \"validFrom\": \"\"\n },\n {\n \"baseCurrency\": \"\",\n \"conversionRate\": \"\",\n \"currencyCode\": \"\",\n \"validFrom\": \"\"\n }\n]" }, "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/currency", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "currency" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization id of the organization to which the currencies are related." }, { "key": "clientId", "value": "", "description": "(Required) Client id of the client to which the currencies are related." } ] }, "description": "Inserts and updates currencies for a given client" }, "response": [ { "name": "If user doesn't have permission to access this resource.", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "[\n {\n \"baseCurrency\": \"\",\n \"conversionRate\": \"\",\n \"currencyCode\": \"\",\n \"validFrom\": \"\"\n },\n {\n \"baseCurrency\": \"\",\n \"conversionRate\": \"\",\n \"currencyCode\": \"\",\n \"validFrom\": \"\"\n }\n]" }, "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/currency", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "currency" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "If any network or client related error occurs.", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "[\n {\n \"baseCurrency\": \"\",\n \"conversionRate\": \"\",\n \"currencyCode\": \"\",\n \"validFrom\": \"\"\n },\n {\n \"baseCurrency\": \"\",\n \"conversionRate\": \"\",\n \"currencyCode\": \"\",\n \"validFrom\": \"\"\n }\n]" }, "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/currency", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "currency" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\"\n}" }, { "name": "The currencies have been processed successfully", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "[\n {\n \"baseCurrency\": \"\",\n \"conversionRate\": \"\",\n \"currencyCode\": \"\",\n \"validFrom\": \"\"\n },\n {\n \"baseCurrency\": \"\",\n \"conversionRate\": \"\",\n \"currencyCode\": \"\",\n \"validFrom\": \"\"\n }\n]" }, "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/currency", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "currency" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"failed\": [\n {\n \"item\": {\n \"baseCurrency\": \"\",\n \"conversionRate\": \"\",\n \"currencyCode\": \"\",\n \"validFrom\": \"\"\n },\n \"message\": \"\"\n },\n {\n \"item\": {\n \"baseCurrency\": \"\",\n \"conversionRate\": \"\",\n \"currencyCode\": \"\",\n \"validFrom\": \"\"\n },\n \"message\": \"\"\n }\n ]\n}" }, { "name": "If security token is not provided or user not authenticated.", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "[\n {\n \"baseCurrency\": \"\",\n \"conversionRate\": \"\",\n \"currencyCode\": \"\",\n \"validFrom\": \"\"\n },\n {\n \"baseCurrency\": \"\",\n \"conversionRate\": \"\",\n \"currencyCode\": \"\",\n \"validFrom\": \"\"\n }\n]" }, "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/currency", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "currency" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Validation of model fails.", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "[\n {\n \"baseCurrency\": \"\",\n \"conversionRate\": \"\",\n \"currencyCode\": \"\",\n \"validFrom\": \"\"\n },\n {\n \"baseCurrency\": \"\",\n \"conversionRate\": \"\",\n \"currencyCode\": \"\",\n \"validFrom\": \"\"\n }\n]" }, "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/currency", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "currency" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "The parent accounting code could not be found.", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "[\n {\n \"baseCurrency\": \"\",\n \"conversionRate\": \"\",\n \"currencyCode\": \"\",\n \"validFrom\": \"\"\n },\n {\n \"baseCurrency\": \"\",\n \"conversionRate\": \"\",\n \"currencyCode\": \"\",\n \"validFrom\": \"\"\n }\n]" }, "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/currency", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "currency" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] }, { "name": "/currency/:code", "request": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/currency/:code", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "currency", ":code" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization id of the organization to which the currency is related." }, { "key": "clientId", "value": "", "description": "(Required) Client id of the client to which the currency is related." }, { "key": "code", "value": "", "description": "(Required) The unique code for the currency" } ] }, "description": "Gets a list of currencies for a given currency code for a given client" }, "response": [ { "name": "The currencies for a given currency code for the given client", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/currency/:code", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "currency", ":code" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" }, { "key": "code" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"baseCurrency\": \"\",\n \"conversionRate\": \"\",\n \"currencyCode\": \"\",\n \"validFrom\": \"\"\n },\n {\n \"baseCurrency\": \"\",\n \"conversionRate\": \"\",\n \"currencyCode\": \"\",\n \"validFrom\": \"\"\n }\n]" }, { "name": "Validation of model fails.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/currency/:code", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "currency", ":code" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" }, { "key": "code" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "If any network or client related error occurs.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/currency/:code", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "currency", ":code" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" }, { "key": "code" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\"\n}" }, { "name": "Accounting code does not exist.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/currency/:code", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "currency", ":code" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" }, { "key": "code" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "If security token is not provided or user not authenticated.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/currency/:code", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "currency", ":code" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" }, { "key": "code" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] } ] }, { "name": "customers", "item": [ { "name": "{code}", "item": [ { "name": "/customers/:code", "request": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/customers/:code", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "customers", ":code" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization id of the organization to which the customer is related." }, { "key": "clientId", "value": "", "description": "(Required) Client id of the client to which the customer is related." }, { "key": "code", "value": "", "description": "(Required) The unique code for the customer" } ] }, "description": "Gets a customer based on the ERP code." }, "response": [ { "name": "If user doesn't have permission to access this resource.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/customers/:code", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "customers", ":code" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" }, { "key": "code" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "If any network or client related error occurs.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/customers/:code", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "customers", ":code" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" }, { "key": "code" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\"\n}" }, { "name": "The customer for the given client with requested code", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/customers/:code", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "customers", ":code" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" }, { "key": "code" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"\",\n \"status\": \"\",\n \"relations\": [\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n },\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n }\n ],\n \"description\": [\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n },\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n }\n ]\n}" }, { "name": "If security token is not provided or user not authenticated.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/customers/:code", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "customers", ":code" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" }, { "key": "code" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Validation of model fails.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/customers/:code", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "customers", ":code" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" }, { "key": "code" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Customer does not exist.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/customers/:code", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "customers", ":code" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" }, { "key": "code" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] }, { "name": "/customers/:code", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/customers/:code", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "customers", ":code" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization id of the organization to which the customer is related." }, { "key": "clientId", "value": "", "description": "(Required) Client id of the client to which the customer is related." }, { "key": "code", "value": "", "description": "(Required) The unique code of the customer to delete" } ] }, "description": "Delete a customer" }, "response": [ { "name": "The accounting code can not be found.", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/customers/:code", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "customers", ":code" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" }, { "key": "code" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Validation of model fails.", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/customers/:code", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "customers", ":code" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" }, { "key": "code" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "If security token is not provided or user not authenticated.", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/customers/:code", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "customers", ":code" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" }, { "key": "code" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "The customer has been deleted successfully", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/customers/:code", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "customers", ":code" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" }, { "key": "code" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"\",\n \"status\": \"\",\n \"relations\": [\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n },\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n }\n ],\n \"description\": [\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n },\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n }\n ]\n}" }, { "name": "If user doesn't have permission to access this resource.", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/customers/:code", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "customers", ":code" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" }, { "key": "code" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "If any network or client related error occurs.", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/customers/:code", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "customers", ":code" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" }, { "key": "code" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\"\n}" } ] } ] }, { "name": "/customers", "request": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/customers?textSearch=", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "customers" ], "query": [ { "key": "textSearch", "value": "", "description": "Optional search for text in codes or descriptions" } ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization id of the organization to which the customers are related." }, { "key": "clientId", "value": "", "description": "(Required) Client id of the client to which the customers are related." } ] }, "description": "Gets all customers for a client." }, "response": [ { "name": "Validation of model fails.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/customers?textSearch=", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "customers" ], "query": [ { "key": "textSearch", "value": "" } ], "variable": [ { "key": "organizationId" }, { "key": "clientId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "If user doesn't have permission to access this resource.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/customers?textSearch=", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "customers" ], "query": [ { "key": "textSearch", "value": "" } ], "variable": [ { "key": "organizationId" }, { "key": "clientId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "The customers for the given client", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/customers?textSearch=", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "customers" ], "query": [ { "key": "textSearch", "value": "" } ], "variable": [ { "key": "organizationId" }, { "key": "clientId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"code\": \"\",\n \"status\": \"\",\n \"relations\": [\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n },\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n }\n ],\n \"description\": [\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n },\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n }\n ]\n },\n {\n \"code\": \"\",\n \"status\": \"\",\n \"relations\": [\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n },\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n }\n ],\n \"description\": [\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n },\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n }\n ]\n }\n]" }, { "name": "If any network or client related error occurs.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/customers?textSearch=", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "customers" ], "query": [ { "key": "textSearch", "value": "" } ], "variable": [ { "key": "organizationId" }, { "key": "clientId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\"\n}" }, { "name": "No customers exist for the given client", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/customers?textSearch=", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "customers" ], "query": [ { "key": "textSearch", "value": "" } ], "variable": [ { "key": "organizationId" }, { "key": "clientId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "If security token is not provided or user not authenticated.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/customers?textSearch=", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "customers" ], "query": [ { "key": "textSearch", "value": "" } ], "variable": [ { "key": "organizationId" }, { "key": "clientId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] }, { "name": "/customers", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "[\n {\n \"code\": \"\",\n \"status\": \"\",\n \"relations\": [\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n },\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n }\n ],\n \"description\": [\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n },\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n }\n ]\n },\n {\n \"code\": \"\",\n \"status\": \"\",\n \"relations\": [\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n },\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n }\n ],\n \"description\": [\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n },\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n }\n ]\n }\n]" }, "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/customers", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "customers" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization id of the organization to which the customers are related." }, { "key": "clientId", "value": "", "description": "(Required) Client id of the client to which the customers are related." } ] }, "description": "Inserts and updates customers for a given client" }, "response": [ { "name": "Validation of model fails.", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "[\n {\n \"code\": \"\",\n \"status\": \"\",\n \"relations\": [\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n },\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n }\n ],\n \"description\": [\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n },\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n }\n ]\n },\n {\n \"code\": \"\",\n \"status\": \"\",\n \"relations\": [\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n },\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n }\n ],\n \"description\": [\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n },\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n }\n ]\n }\n]" }, "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/customers", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "customers" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "If security token is not provided or user not authenticated.", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "[\n {\n \"code\": \"\",\n \"status\": \"\",\n \"relations\": [\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n },\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n }\n ],\n \"description\": [\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n },\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n }\n ]\n },\n {\n \"code\": \"\",\n \"status\": \"\",\n \"relations\": [\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n },\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n }\n ],\n \"description\": [\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n },\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n }\n ]\n }\n]" }, "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/customers", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "customers" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "The parent accounting code could not be found.", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "[\n {\n \"code\": \"\",\n \"status\": \"\",\n \"relations\": [\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n },\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n }\n ],\n \"description\": [\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n },\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n }\n ]\n },\n {\n \"code\": \"\",\n \"status\": \"\",\n \"relations\": [\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n },\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n }\n ],\n \"description\": [\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n },\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n }\n ]\n }\n]" }, "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/customers", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "customers" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "The customers have been processed successfully", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "[\n {\n \"code\": \"\",\n \"status\": \"\",\n \"relations\": [\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n },\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n }\n ],\n \"description\": [\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n },\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n }\n ]\n },\n {\n \"code\": \"\",\n \"status\": \"\",\n \"relations\": [\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n },\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n }\n ],\n \"description\": [\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n },\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n }\n ]\n }\n]" }, "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/customers", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "customers" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"failed\": [\n {\n \"item\": {\n \"code\": \"\",\n \"status\": \"\",\n \"relations\": [\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n },\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n }\n ],\n \"description\": [\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n },\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n }\n ]\n },\n \"message\": \"\"\n },\n {\n \"item\": {\n \"code\": \"\",\n \"status\": \"\",\n \"relations\": [\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n },\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n }\n ],\n \"description\": [\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n },\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n }\n ]\n },\n \"message\": \"\"\n }\n ]\n}" }, { "name": "If user doesn't have permission to access this resource.", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "[\n {\n \"code\": \"\",\n \"status\": \"\",\n \"relations\": [\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n },\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n }\n ],\n \"description\": [\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n },\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n }\n ]\n },\n {\n \"code\": \"\",\n \"status\": \"\",\n \"relations\": [\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n },\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n }\n ],\n \"description\": [\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n },\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n }\n ]\n }\n]" }, "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/customers", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "customers" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "If any network or client related error occurs.", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "[\n {\n \"code\": \"\",\n \"status\": \"\",\n \"relations\": [\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n },\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n }\n ],\n \"description\": [\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n },\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n }\n ]\n },\n {\n \"code\": \"\",\n \"status\": \"\",\n \"relations\": [\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n },\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n }\n ],\n \"description\": [\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n },\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n }\n ]\n }\n]" }, "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/customers", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "customers" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\"\n}" } ] } ] }, { "name": "dimensions", "item": [ { "name": "{dimension Code}", "item": [ { "name": "values", "item": [ { "name": "{dimension Value Code}", "item": [ { "name": "/dimensions/:dimensionCode/values/:dimensionValueCode", "request": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/dimensions/:dimensionCode/values/:dimensionValueCode", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "dimensions", ":dimensionCode", "values", ":dimensionValueCode" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization id of the organization to which the dimension value is related." }, { "key": "clientId", "value": "", "description": "(Required) Client id of the client to which the dimension value is related." }, { "key": "dimensionCode", "value": "", "description": "(Required) The code for the parent dimension category" }, { "key": "dimensionValueCode", "value": "", "description": "(Required) The code for the dimension value" } ] }, "description": "Gets a dimension value based on the dimension code and the dimension value code. The dimension code can be seen as a categorization of dimensions, while the dimension value code\r\nis the actual dimension." }, "response": [ { "name": "If security token is not provided or user not authenticated.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/dimensions/:dimensionCode/values/:dimensionValueCode", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "dimensions", ":dimensionCode", "values", ":dimensionValueCode" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" }, { "key": "dimensionCode" }, { "key": "dimensionValueCode" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "The dimension value for the given client with requested dimension category code and dimension value code", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/dimensions/:dimensionCode/values/:dimensionValueCode", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "dimensions", ":dimensionCode", "values", ":dimensionValueCode" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" }, { "key": "dimensionCode" }, { "key": "dimensionValueCode" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"\",\n \"dimensionCode\": \"\",\n \"status\": \"\",\n \"relations\": [\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n },\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n }\n ],\n \"aliases\": [\n \"\",\n \"\"\n ],\n \"description\": [\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n },\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n }\n ]\n}" }, { "name": "Dimension value does not exist.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/dimensions/:dimensionCode/values/:dimensionValueCode", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "dimensions", ":dimensionCode", "values", ":dimensionValueCode" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" }, { "key": "dimensionCode" }, { "key": "dimensionValueCode" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "If any network or client related error occurs.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/dimensions/:dimensionCode/values/:dimensionValueCode", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "dimensions", ":dimensionCode", "values", ":dimensionValueCode" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" }, { "key": "dimensionCode" }, { "key": "dimensionValueCode" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\"\n}" }, { "name": "If user doesn't have permission to access this resource.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/dimensions/:dimensionCode/values/:dimensionValueCode", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "dimensions", ":dimensionCode", "values", ":dimensionValueCode" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" }, { "key": "dimensionCode" }, { "key": "dimensionValueCode" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Validation of model fails.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/dimensions/:dimensionCode/values/:dimensionValueCode", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "dimensions", ":dimensionCode", "values", ":dimensionValueCode" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" }, { "key": "dimensionCode" }, { "key": "dimensionValueCode" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] }, { "name": "/dimensions/:dimensionCode/values/:dimensionValueCode", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/dimensions/:dimensionCode/values/:dimensionValueCode", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "dimensions", ":dimensionCode", "values", ":dimensionValueCode" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization id of the organization to which the dimension value is related." }, { "key": "clientId", "value": "", "description": "(Required) Client id of the client to which the dimension value is related." }, { "key": "dimensionCode", "value": "", "description": "(Required) The dimension code of the parent dimension of the dimension value to delete" }, { "key": "dimensionValueCode", "value": "", "description": "(Required) The dimension value code of the dimension value to delete" } ] }, "description": "Delete a dimension value" }, "response": [ { "name": "If any network or client related error occurs.", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/dimensions/:dimensionCode/values/:dimensionValueCode", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "dimensions", ":dimensionCode", "values", ":dimensionValueCode" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" }, { "key": "dimensionCode" }, { "key": "dimensionValueCode" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\"\n}" }, { "name": "The child dimension has been deleted successfully", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/dimensions/:dimensionCode/values/:dimensionValueCode", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "dimensions", ":dimensionCode", "values", ":dimensionValueCode" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" }, { "key": "dimensionCode" }, { "key": "dimensionValueCode" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"\",\n \"dimensionCode\": \"\",\n \"status\": \"\",\n \"relations\": [\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n },\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n }\n ],\n \"aliases\": [\n \"\",\n \"\"\n ],\n \"description\": [\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n },\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n }\n ]\n}" }, { "name": "If security token is not provided or user not authenticated.", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/dimensions/:dimensionCode/values/:dimensionValueCode", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "dimensions", ":dimensionCode", "values", ":dimensionValueCode" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" }, { "key": "dimensionCode" }, { "key": "dimensionValueCode" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Validation of model fails.", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/dimensions/:dimensionCode/values/:dimensionValueCode", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "dimensions", ":dimensionCode", "values", ":dimensionValueCode" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" }, { "key": "dimensionCode" }, { "key": "dimensionValueCode" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "If user doesn't have permission to access this resource.", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/dimensions/:dimensionCode/values/:dimensionValueCode", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "dimensions", ":dimensionCode", "values", ":dimensionValueCode" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" }, { "key": "dimensionCode" }, { "key": "dimensionValueCode" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] } ] }, { "name": "/dimensions/:dimensionCode/values", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "[\n {\n \"code\": \"\",\n \"dimensionCode\": \"\",\n \"status\": \"\",\n \"relations\": [\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n },\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n }\n ],\n \"aliases\": [\n \"\",\n \"\"\n ],\n \"description\": [\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n },\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n }\n ]\n },\n {\n \"code\": \"\",\n \"dimensionCode\": \"\",\n \"status\": \"\",\n \"relations\": [\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n },\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n }\n ],\n \"aliases\": [\n \"\",\n \"\"\n ],\n \"description\": [\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n },\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n }\n ]\n }\n]" }, "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/dimensions/:dimensionCode/values", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "dimensions", ":dimensionCode", "values" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization id of the organization to which the dimension values are related." }, { "key": "clientId", "value": "", "description": "(Required) Client id of the client to which the dimension values are related." }, { "key": "dimensionCode", "value": "", "description": "(Required) The dimension code of the parent dimension." } ] }, "description": "Inserts and updates dimension values for a dimension for a given client. These are the actual dimension values that should be connected to the parent dimension code." }, "response": [ { "name": "The dimension values have been processed successfully", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "[\n {\n \"code\": \"\",\n \"dimensionCode\": \"\",\n \"status\": \"\",\n \"relations\": [\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n },\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n }\n ],\n \"aliases\": [\n \"\",\n \"\"\n ],\n \"description\": [\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n },\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n }\n ]\n },\n {\n \"code\": \"\",\n \"dimensionCode\": \"\",\n \"status\": \"\",\n \"relations\": [\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n },\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n }\n ],\n \"aliases\": [\n \"\",\n \"\"\n ],\n \"description\": [\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n },\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n }\n ]\n }\n]" }, "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/dimensions/:dimensionCode/values", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "dimensions", ":dimensionCode", "values" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" }, { "key": "dimensionCode" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"failed\": [\n {\n \"item\": {\n \"code\": \"\",\n \"dimensionCode\": \"\",\n \"status\": \"\",\n \"relations\": [\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n },\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n }\n ],\n \"aliases\": [\n \"\",\n \"\"\n ],\n \"description\": [\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n },\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n }\n ]\n },\n \"message\": \"\"\n },\n {\n \"item\": {\n \"code\": \"\",\n \"dimensionCode\": \"\",\n \"status\": \"\",\n \"relations\": [\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n },\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n }\n ],\n \"aliases\": [\n \"\",\n \"\"\n ],\n \"description\": [\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n },\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n }\n ]\n },\n \"message\": \"\"\n }\n ]\n}" }, { "name": "Validation of model fails.", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "[\n {\n \"code\": \"\",\n \"dimensionCode\": \"\",\n \"status\": \"\",\n \"relations\": [\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n },\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n }\n ],\n \"aliases\": [\n \"\",\n \"\"\n ],\n \"description\": [\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n },\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n }\n ]\n },\n {\n \"code\": \"\",\n \"dimensionCode\": \"\",\n \"status\": \"\",\n \"relations\": [\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n },\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n }\n ],\n \"aliases\": [\n \"\",\n \"\"\n ],\n \"description\": [\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n },\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n }\n ]\n }\n]" }, "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/dimensions/:dimensionCode/values", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "dimensions", ":dimensionCode", "values" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" }, { "key": "dimensionCode" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "If user doesn't have permission to access this resource.", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "[\n {\n \"code\": \"\",\n \"dimensionCode\": \"\",\n \"status\": \"\",\n \"relations\": [\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n },\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n }\n ],\n \"aliases\": [\n \"\",\n \"\"\n ],\n \"description\": [\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n },\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n }\n ]\n },\n {\n \"code\": \"\",\n \"dimensionCode\": \"\",\n \"status\": \"\",\n \"relations\": [\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n },\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n }\n ],\n \"aliases\": [\n \"\",\n \"\"\n ],\n \"description\": [\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n },\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n }\n ]\n }\n]" }, "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/dimensions/:dimensionCode/values", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "dimensions", ":dimensionCode", "values" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" }, { "key": "dimensionCode" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "If security token is not provided or user not authenticated.", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "[\n {\n \"code\": \"\",\n \"dimensionCode\": \"\",\n \"status\": \"\",\n \"relations\": [\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n },\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n }\n ],\n \"aliases\": [\n \"\",\n \"\"\n ],\n \"description\": [\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n },\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n }\n ]\n },\n {\n \"code\": \"\",\n \"dimensionCode\": \"\",\n \"status\": \"\",\n \"relations\": [\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n },\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n }\n ],\n \"aliases\": [\n \"\",\n \"\"\n ],\n \"description\": [\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n },\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n }\n ]\n }\n]" }, "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/dimensions/:dimensionCode/values", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "dimensions", ":dimensionCode", "values" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" }, { "key": "dimensionCode" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "If any network or client related error occurs.", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "[\n {\n \"code\": \"\",\n \"dimensionCode\": \"\",\n \"status\": \"\",\n \"relations\": [\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n },\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n }\n ],\n \"aliases\": [\n \"\",\n \"\"\n ],\n \"description\": [\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n },\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n }\n ]\n },\n {\n \"code\": \"\",\n \"dimensionCode\": \"\",\n \"status\": \"\",\n \"relations\": [\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n },\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n }\n ],\n \"aliases\": [\n \"\",\n \"\"\n ],\n \"description\": [\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n },\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n }\n ]\n }\n]" }, "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/dimensions/:dimensionCode/values", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "dimensions", ":dimensionCode", "values" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" }, { "key": "dimensionCode" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\"\n}" } ] } ] }, { "name": "/dimensions/:dimensionCode", "request": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/dimensions/:dimensionCode", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "dimensions", ":dimensionCode" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization id of the organization to which the dimension is related." }, { "key": "clientId", "value": "", "description": "(Required) Client id of the client to which the dimension category is related." }, { "key": "dimensionCode", "value": "", "description": "(Required) The code for the dimension category" } ] }, "description": "Gets a parent dimension based on the dimension code. The parent dimension can be seen as a way of categorizing dimensions and not the specific dimension values themselves." }, "response": [ { "name": "The dimension for the given client with requested code", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/dimensions/:dimensionCode", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "dimensions", ":dimensionCode" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" }, { "key": "dimensionCode" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"\",\n \"status\": \"\",\n \"analyzeLines\": \"\",\n \"description\": [\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n },\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n }\n ]\n}" }, { "name": "If user doesn't have permission to access this resource.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/dimensions/:dimensionCode", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "dimensions", ":dimensionCode" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" }, { "key": "dimensionCode" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "If security token is not provided or user not authenticated.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/dimensions/:dimensionCode", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "dimensions", ":dimensionCode" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" }, { "key": "dimensionCode" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "If any network or client related error occurs.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/dimensions/:dimensionCode", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "dimensions", ":dimensionCode" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" }, { "key": "dimensionCode" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\"\n}" }, { "name": "Dimension does not exist.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/dimensions/:dimensionCode", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "dimensions", ":dimensionCode" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" }, { "key": "dimensionCode" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Validation of model fails.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/dimensions/:dimensionCode", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "dimensions", ":dimensionCode" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" }, { "key": "dimensionCode" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] }, { "name": "/dimensions/:dimensionCode", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/dimensions/:dimensionCode", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "dimensions", ":dimensionCode" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization id of the organization to which the dimension is related." }, { "key": "clientId", "value": "", "description": "(Required) Client id of the client to which the dimension is related." }, { "key": "dimensionCode", "value": "", "description": "(Required) The dimension code of the parent dimension to delete" } ] }, "description": "Delete a parent dimension" }, "response": [ { "name": "If user doesn't have permission to access this resource.", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/dimensions/:dimensionCode", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "dimensions", ":dimensionCode" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" }, { "key": "dimensionCode" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Validation of model fails.", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/dimensions/:dimensionCode", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "dimensions", ":dimensionCode" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" }, { "key": "dimensionCode" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "The parent dimension has been deleted successfully", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/dimensions/:dimensionCode", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "dimensions", ":dimensionCode" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" }, { "key": "dimensionCode" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"\",\n \"status\": \"\",\n \"analyzeLines\": \"\",\n \"description\": [\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n },\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n }\n ]\n}" }, { "name": "If any network or client related error occurs.", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/dimensions/:dimensionCode", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "dimensions", ":dimensionCode" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" }, { "key": "dimensionCode" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\"\n}" }, { "name": "If security token is not provided or user not authenticated.", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/dimensions/:dimensionCode", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "dimensions", ":dimensionCode" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" }, { "key": "dimensionCode" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] } ] }, { "name": "/dimensions", "request": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/dimensions", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "dimensions" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization id of the organization to which the parent dimensions are related." }, { "key": "clientId", "value": "", "description": "(Required) Client id of the client to which the parent dimensions are related." } ] }, "description": "Gets all parent dimensions for a given. The parent dimension can be seen as a way of categorizing dimensions and not the specific dimension values themselves." }, "response": [ { "name": "If user doesn't have permission to access this resource.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/dimensions", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "dimensions" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "The parent dimensions for the given client", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/dimensions", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "dimensions" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"code\": \"\",\n \"status\": \"\",\n \"analyzeLines\": \"\",\n \"description\": [\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n },\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n }\n ]\n },\n {\n \"code\": \"\",\n \"status\": \"\",\n \"analyzeLines\": \"\",\n \"description\": [\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n },\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n }\n ]\n }\n]" }, { "name": "If any network or client related error occurs.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/dimensions", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "dimensions" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\"\n}" }, { "name": "Validation of model fails.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/dimensions", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "dimensions" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "No parent dimensions exist for the given client.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/dimensions", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "dimensions" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "If security token is not provided or user not authenticated.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/dimensions", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "dimensions" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] }, { "name": "/dimensions", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"status\": \"\",\n \"analyzeLines\": \"\",\n \"description\": [\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n },\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n }\n ]\n}" }, "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/dimensions", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "dimensions" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization id of the organization to which the dimension is related." }, { "key": "clientId", "value": "", "description": "(Required) Client id of the client to which the dimension is related." } ] }, "description": "Inserts and updates a dimension for a given client. This can be seen as the dimension categories and not the specific dimension themselves." }, "response": [ { "name": "If user doesn't have permission to access this resource.", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"status\": \"\",\n \"analyzeLines\": \"\",\n \"description\": [\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n },\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n }\n ]\n}" }, "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/dimensions", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "dimensions" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "If security token is not provided or user not authenticated.", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"status\": \"\",\n \"analyzeLines\": \"\",\n \"description\": [\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n },\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n }\n ]\n}" }, "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/dimensions", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "dimensions" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "If any network or client related error occurs.", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"status\": \"\",\n \"analyzeLines\": \"\",\n \"description\": [\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n },\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n }\n ]\n}" }, "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/dimensions", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "dimensions" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\"\n}" }, { "name": "The dimension have been processed successfully", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"status\": \"\",\n \"analyzeLines\": \"\",\n \"description\": [\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n },\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n }\n ]\n}" }, "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/dimensions", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "dimensions" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"\",\n \"status\": \"\",\n \"analyzeLines\": \"\",\n \"description\": [\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n },\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n }\n ]\n}" }, { "name": "Validation of model fails.", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"status\": \"\",\n \"analyzeLines\": \"\",\n \"description\": [\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n },\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n }\n ]\n}" }, "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/dimensions", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "dimensions" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] } ] }, { "name": "fixedassets", "item": [ { "name": "{code}", "item": [ { "name": "/fixedassets/:code", "request": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/fixedassets/:code", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "fixedassets", ":code" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization id of the organization to which the fixed asset is related." }, { "key": "clientId", "value": "", "description": "(Required) Client id of the client to which the fixed asset is related." }, { "key": "code", "value": "", "description": "(Required) The ERP code for the fixed asset" } ] }, "description": "Gets a fixed asset object based on the ERP code." }, "response": [ { "name": "Validation of model fails.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/fixedassets/:code", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "fixedassets", ":code" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" }, { "key": "code" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Fixed asset does not exist.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/fixedassets/:code", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "fixedassets", ":code" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" }, { "key": "code" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "If security token is not provided or user not authenticated.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/fixedassets/:code", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "fixedassets", ":code" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" }, { "key": "code" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "If any network or client related error occurs.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/fixedassets/:code", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "fixedassets", ":code" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" }, { "key": "code" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\"\n}" }, { "name": "If user doesn't have permission to access this resource.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/fixedassets/:code", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "fixedassets", ":code" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" }, { "key": "code" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "The fixed asset for the given client with requested ERP code", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/fixedassets/:code", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "fixedassets", ":code" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" }, { "key": "code" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"\",\n \"status\": \"\",\n \"relations\": [\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n },\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n }\n ],\n \"description\": [\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n },\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n }\n ]\n}" } ] }, { "name": "/fixedassets/:code", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/fixedassets/:code", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "fixedassets", ":code" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization id of the organization to which the fixed asset is related." }, { "key": "clientId", "value": "", "description": "(Required) Client id of the client to which the fixed asset is related." }, { "key": "code", "value": "", "description": "(Required) The ERP code of fixed asset to delete" } ] }, "description": "Delete a fixed asset" }, "response": [ { "name": "If security token is not provided or user not authenticated.", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/fixedassets/:code", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "fixedassets", ":code" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" }, { "key": "code" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "If user doesn't have permission to access this resource.", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/fixedassets/:code", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "fixedassets", ":code" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" }, { "key": "code" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Validation of model fails.", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/fixedassets/:code", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "fixedassets", ":code" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" }, { "key": "code" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "If any network or client related error occurs.", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/fixedassets/:code", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "fixedassets", ":code" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" }, { "key": "code" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\"\n}" }, { "name": "The fixed asset has been deleted successfully", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/fixedassets/:code", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "fixedassets", ":code" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" }, { "key": "code" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"\",\n \"status\": \"\",\n \"relations\": [\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n },\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n }\n ],\n \"description\": [\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n },\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n }\n ]\n}" } ] } ] }, { "name": "/fixedassets", "request": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/fixedassets?textSearch=", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "fixedassets" ], "query": [ { "key": "textSearch", "value": "", "description": "Optional search for text in codes or descriptions" } ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization id of the organization to which the fixed assets are related." }, { "key": "clientId", "value": "", "description": "(Required) Client id of the client to which the fixed assets are related." } ] }, "description": "Gets all fixed assets for a client." }, "response": [ { "name": "If security token is not provided or user not authenticated.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/fixedassets?textSearch=", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "fixedassets" ], "query": [ { "key": "textSearch", "value": "" } ], "variable": [ { "key": "organizationId" }, { "key": "clientId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "If any network or client related error occurs.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/fixedassets?textSearch=", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "fixedassets" ], "query": [ { "key": "textSearch", "value": "" } ], "variable": [ { "key": "organizationId" }, { "key": "clientId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\"\n}" }, { "name": "The fixed assets for the given client", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/fixedassets?textSearch=", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "fixedassets" ], "query": [ { "key": "textSearch", "value": "" } ], "variable": [ { "key": "organizationId" }, { "key": "clientId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"code\": \"\",\n \"status\": \"\",\n \"relations\": [\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n },\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n }\n ],\n \"description\": [\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n },\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n }\n ]\n },\n {\n \"code\": \"\",\n \"status\": \"\",\n \"relations\": [\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n },\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n }\n ],\n \"description\": [\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n },\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n }\n ]\n }\n]" }, { "name": "Validation of model fails.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/fixedassets?textSearch=", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "fixedassets" ], "query": [ { "key": "textSearch", "value": "" } ], "variable": [ { "key": "organizationId" }, { "key": "clientId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "If user doesn't have permission to access this resource.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/fixedassets?textSearch=", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "fixedassets" ], "query": [ { "key": "textSearch", "value": "" } ], "variable": [ { "key": "organizationId" }, { "key": "clientId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "No fixed assets exist for the given client", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/fixedassets?textSearch=", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "fixedassets" ], "query": [ { "key": "textSearch", "value": "" } ], "variable": [ { "key": "organizationId" }, { "key": "clientId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] }, { "name": "/fixedassets", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "[\n {\n \"code\": \"\",\n \"status\": \"\",\n \"relations\": [\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n },\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n }\n ],\n \"description\": [\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n },\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n }\n ]\n },\n {\n \"code\": \"\",\n \"status\": \"\",\n \"relations\": [\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n },\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n }\n ],\n \"description\": [\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n },\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n }\n ]\n }\n]" }, "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/fixedassets", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "fixedassets" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization id of the organization to which the fixed assets are related." }, { "key": "clientId", "value": "", "description": "(Required) Client id of the client to which the fixed assets are related." } ] }, "description": "Inserts and updates fixed assets for a given client" }, "response": [ { "name": "If user doesn't have permission to access this resource.", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "[\n {\n \"code\": \"\",\n \"status\": \"\",\n \"relations\": [\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n },\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n }\n ],\n \"description\": [\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n },\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n }\n ]\n },\n {\n \"code\": \"\",\n \"status\": \"\",\n \"relations\": [\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n },\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n }\n ],\n \"description\": [\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n },\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n }\n ]\n }\n]" }, "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/fixedassets", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "fixedassets" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "If security token is not provided or user not authenticated.", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "[\n {\n \"code\": \"\",\n \"status\": \"\",\n \"relations\": [\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n },\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n }\n ],\n \"description\": [\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n },\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n }\n ]\n },\n {\n \"code\": \"\",\n \"status\": \"\",\n \"relations\": [\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n },\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n }\n ],\n \"description\": [\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n },\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n }\n ]\n }\n]" }, "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/fixedassets", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "fixedassets" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "The fixed assets have been processed successfully", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "[\n {\n \"code\": \"\",\n \"status\": \"\",\n \"relations\": [\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n },\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n }\n ],\n \"description\": [\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n },\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n }\n ]\n },\n {\n \"code\": \"\",\n \"status\": \"\",\n \"relations\": [\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n },\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n }\n ],\n \"description\": [\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n },\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n }\n ]\n }\n]" }, "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/fixedassets", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "fixedassets" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"failed\": [\n {\n \"item\": {\n \"code\": \"\",\n \"status\": \"\",\n \"relations\": [\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n },\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n }\n ],\n \"description\": [\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n },\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n }\n ]\n },\n \"message\": \"\"\n },\n {\n \"item\": {\n \"code\": \"\",\n \"status\": \"\",\n \"relations\": [\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n },\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n }\n ],\n \"description\": [\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n },\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n }\n ]\n },\n \"message\": \"\"\n }\n ]\n}" }, { "name": "If any network or client related error occurs.", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "[\n {\n \"code\": \"\",\n \"status\": \"\",\n \"relations\": [\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n },\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n }\n ],\n \"description\": [\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n },\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n }\n ]\n },\n {\n \"code\": \"\",\n \"status\": \"\",\n \"relations\": [\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n },\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n }\n ],\n \"description\": [\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n },\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n }\n ]\n }\n]" }, "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/fixedassets", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "fixedassets" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\"\n}" }, { "name": "Validation of model fails.", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "[\n {\n \"code\": \"\",\n \"status\": \"\",\n \"relations\": [\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n },\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n }\n ],\n \"description\": [\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n },\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n }\n ]\n },\n {\n \"code\": \"\",\n \"status\": \"\",\n \"relations\": [\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n },\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n }\n ],\n \"description\": [\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n },\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n }\n ]\n }\n]" }, "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/fixedassets", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "fixedassets" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] } ] }, { "name": "inference", "item": [ { "name": "/inference/predict", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"vendorCode\": \"\",\n \"numberOfResults\": \"\",\n \"parametersToPredict\": [\n \"\",\n \"\"\n ],\n \"headerData\": {\n \"buyerReference\": \"\",\n \"orderReference\": \"\"\n },\n \"lineItems\": [\n {\n \"lineItemId\": \"\",\n \"description\": \"\",\n \"accountType\": \"\",\n \"accountValue\": \"\",\n \"accountSecondaryValue\": \"\",\n \"vatPercent\": \"\",\n \"vatCode\": \"\",\n \"dimensions\": \"\"\n },\n {\n \"lineItemId\": \"\",\n \"description\": \"\",\n \"accountType\": \"\",\n \"accountValue\": \"\",\n \"accountSecondaryValue\": \"\",\n \"vatPercent\": \"\",\n \"vatCode\": \"\",\n \"dimensions\": \"\"\n }\n ]\n}" }, "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/inference/predict", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "inference", "predict" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization id" }, { "key": "clientId", "value": "", "description": "(Required) Client id" } ] }, "description": "Predicts data with Semine AI" }, "response": [ { "name": "If any network or client related error occurs.", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"vendorCode\": \"\",\n \"numberOfResults\": \"\",\n \"parametersToPredict\": [\n \"\",\n \"\"\n ],\n \"headerData\": {\n \"buyerReference\": \"\",\n \"orderReference\": \"\"\n },\n \"lineItems\": [\n {\n \"lineItemId\": \"\",\n \"description\": \"\",\n \"accountType\": \"\",\n \"accountValue\": \"\",\n \"accountSecondaryValue\": \"\",\n \"vatPercent\": \"\",\n \"vatCode\": \"\",\n \"dimensions\": \"\"\n },\n {\n \"lineItemId\": \"\",\n \"description\": \"\",\n \"accountType\": \"\",\n \"accountValue\": \"\",\n \"accountSecondaryValue\": \"\",\n \"vatPercent\": \"\",\n \"vatCode\": \"\",\n \"dimensions\": \"\"\n }\n ]\n}" }, "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/inference/predict", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "inference", "predict" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\"\n}" }, { "name": "The prediction result", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"vendorCode\": \"\",\n \"numberOfResults\": \"\",\n \"parametersToPredict\": [\n \"\",\n \"\"\n ],\n \"headerData\": {\n \"buyerReference\": \"\",\n \"orderReference\": \"\"\n },\n \"lineItems\": [\n {\n \"lineItemId\": \"\",\n \"description\": \"\",\n \"accountType\": \"\",\n \"accountValue\": \"\",\n \"accountSecondaryValue\": \"\",\n \"vatPercent\": \"\",\n \"vatCode\": \"\",\n \"dimensions\": \"\"\n },\n {\n \"lineItemId\": \"\",\n \"description\": \"\",\n \"accountType\": \"\",\n \"accountValue\": \"\",\n \"accountSecondaryValue\": \"\",\n \"vatPercent\": \"\",\n \"vatCode\": \"\",\n \"dimensions\": \"\"\n }\n ]\n}" }, "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/inference/predict", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "inference", "predict" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"\",\n \"status\": \"\",\n \"relations\": [\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n },\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n }\n ],\n \"vatRates\": [\n {\n \"ratePercentage\": \"\",\n \"validFrom\": \"\"\n },\n {\n \"ratePercentage\": \"\",\n \"validFrom\": \"\"\n }\n ],\n \"costRates\": [\n {\n \"ratePercentage\": \"\",\n \"validFrom\": \"\"\n },\n {\n \"ratePercentage\": \"\",\n \"validFrom\": \"\"\n }\n ],\n \"description\": [\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n },\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n }\n ]\n}" }, { "name": "If security token is not provided or user not authenticated.", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"vendorCode\": \"\",\n \"numberOfResults\": \"\",\n \"parametersToPredict\": [\n \"\",\n \"\"\n ],\n \"headerData\": {\n \"buyerReference\": \"\",\n \"orderReference\": \"\"\n },\n \"lineItems\": [\n {\n \"lineItemId\": \"\",\n \"description\": \"\",\n \"accountType\": \"\",\n \"accountValue\": \"\",\n \"accountSecondaryValue\": \"\",\n \"vatPercent\": \"\",\n \"vatCode\": \"\",\n \"dimensions\": \"\"\n },\n {\n \"lineItemId\": \"\",\n \"description\": \"\",\n \"accountType\": \"\",\n \"accountValue\": \"\",\n \"accountSecondaryValue\": \"\",\n \"vatPercent\": \"\",\n \"vatCode\": \"\",\n \"dimensions\": \"\"\n }\n ]\n}" }, "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/inference/predict", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "inference", "predict" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Validation of model fails.", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"vendorCode\": \"\",\n \"numberOfResults\": \"\",\n \"parametersToPredict\": [\n \"\",\n \"\"\n ],\n \"headerData\": {\n \"buyerReference\": \"\",\n \"orderReference\": \"\"\n },\n \"lineItems\": [\n {\n \"lineItemId\": \"\",\n \"description\": \"\",\n \"accountType\": \"\",\n \"accountValue\": \"\",\n \"accountSecondaryValue\": \"\",\n \"vatPercent\": \"\",\n \"vatCode\": \"\",\n \"dimensions\": \"\"\n },\n {\n \"lineItemId\": \"\",\n \"description\": \"\",\n \"accountType\": \"\",\n \"accountValue\": \"\",\n \"accountSecondaryValue\": \"\",\n \"vatPercent\": \"\",\n \"vatCode\": \"\",\n \"dimensions\": \"\"\n }\n ]\n}" }, "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/inference/predict", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "inference", "predict" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "If user doesn't have permission to access this resource.", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"vendorCode\": \"\",\n \"numberOfResults\": \"\",\n \"parametersToPredict\": [\n \"\",\n \"\"\n ],\n \"headerData\": {\n \"buyerReference\": \"\",\n \"orderReference\": \"\"\n },\n \"lineItems\": [\n {\n \"lineItemId\": \"\",\n \"description\": \"\",\n \"accountType\": \"\",\n \"accountValue\": \"\",\n \"accountSecondaryValue\": \"\",\n \"vatPercent\": \"\",\n \"vatCode\": \"\",\n \"dimensions\": \"\"\n },\n {\n \"lineItemId\": \"\",\n \"description\": \"\",\n \"accountType\": \"\",\n \"accountValue\": \"\",\n \"accountSecondaryValue\": \"\",\n \"vatPercent\": \"\",\n \"vatCode\": \"\",\n \"dimensions\": \"\"\n }\n ]\n}" }, "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/inference/predict", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "inference", "predict" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] }, { "name": "/inference/train", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "[\n {\n \"vendorCode\": \"\",\n \"headerData\": {\n \"buyerReference\": \"\",\n \"orderReference\": \"\"\n },\n \"lineItems\": [\n {\n \"description\": \"\",\n \"accountType\": \"\",\n \"accountValue\": \"\",\n \"accountSecondaryValue\": \"\",\n \"vatPercent\": \"\",\n \"vatCode\": \"\",\n \"dimensions\": \"\"\n },\n {\n \"description\": \"\",\n \"accountType\": \"\",\n \"accountValue\": \"\",\n \"accountSecondaryValue\": \"\",\n \"vatPercent\": \"\",\n \"vatCode\": \"\",\n \"dimensions\": \"\"\n }\n ]\n },\n {\n \"vendorCode\": \"\",\n \"headerData\": {\n \"buyerReference\": \"\",\n \"orderReference\": \"\"\n },\n \"lineItems\": [\n {\n \"description\": \"\",\n \"accountType\": \"\",\n \"accountValue\": \"\",\n \"accountSecondaryValue\": \"\",\n \"vatPercent\": \"\",\n \"vatCode\": \"\",\n \"dimensions\": \"\"\n },\n {\n \"description\": \"\",\n \"accountType\": \"\",\n \"accountValue\": \"\",\n \"accountSecondaryValue\": \"\",\n \"vatPercent\": \"\",\n \"vatCode\": \"\",\n \"dimensions\": \"\"\n }\n ]\n }\n]" }, "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/inference/train", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "inference", "train" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization id" }, { "key": "clientId", "value": "", "description": "(Required) Client id" } ] }, "description": "Train the AI model for the given client" }, "response": [ { "name": "If security token is not provided or user not authenticated.", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "[\n {\n \"vendorCode\": \"\",\n \"headerData\": {\n \"buyerReference\": \"\",\n \"orderReference\": \"\"\n },\n \"lineItems\": [\n {\n \"description\": \"\",\n \"accountType\": \"\",\n \"accountValue\": \"\",\n \"accountSecondaryValue\": \"\",\n \"vatPercent\": \"\",\n \"vatCode\": \"\",\n \"dimensions\": \"\"\n },\n {\n \"description\": \"\",\n \"accountType\": \"\",\n \"accountValue\": \"\",\n \"accountSecondaryValue\": \"\",\n \"vatPercent\": \"\",\n \"vatCode\": \"\",\n \"dimensions\": \"\"\n }\n ]\n },\n {\n \"vendorCode\": \"\",\n \"headerData\": {\n \"buyerReference\": \"\",\n \"orderReference\": \"\"\n },\n \"lineItems\": [\n {\n \"description\": \"\",\n \"accountType\": \"\",\n \"accountValue\": \"\",\n \"accountSecondaryValue\": \"\",\n \"vatPercent\": \"\",\n \"vatCode\": \"\",\n \"dimensions\": \"\"\n },\n {\n \"description\": \"\",\n \"accountType\": \"\",\n \"accountValue\": \"\",\n \"accountSecondaryValue\": \"\",\n \"vatPercent\": \"\",\n \"vatCode\": \"\",\n \"dimensions\": \"\"\n }\n ]\n }\n]" }, "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/inference/train", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "inference", "train" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "If user doesn't have permission to access this resource.", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "[\n {\n \"vendorCode\": \"\",\n \"headerData\": {\n \"buyerReference\": \"\",\n \"orderReference\": \"\"\n },\n \"lineItems\": [\n {\n \"description\": \"\",\n \"accountType\": \"\",\n \"accountValue\": \"\",\n \"accountSecondaryValue\": \"\",\n \"vatPercent\": \"\",\n \"vatCode\": \"\",\n \"dimensions\": \"\"\n },\n {\n \"description\": \"\",\n \"accountType\": \"\",\n \"accountValue\": \"\",\n \"accountSecondaryValue\": \"\",\n \"vatPercent\": \"\",\n \"vatCode\": \"\",\n \"dimensions\": \"\"\n }\n ]\n },\n {\n \"vendorCode\": \"\",\n \"headerData\": {\n \"buyerReference\": \"\",\n \"orderReference\": \"\"\n },\n \"lineItems\": [\n {\n \"description\": \"\",\n \"accountType\": \"\",\n \"accountValue\": \"\",\n \"accountSecondaryValue\": \"\",\n \"vatPercent\": \"\",\n \"vatCode\": \"\",\n \"dimensions\": \"\"\n },\n {\n \"description\": \"\",\n \"accountType\": \"\",\n \"accountValue\": \"\",\n \"accountSecondaryValue\": \"\",\n \"vatPercent\": \"\",\n \"vatCode\": \"\",\n \"dimensions\": \"\"\n }\n ]\n }\n]" }, "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/inference/train", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "inference", "train" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "The training was successfully processed", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "[\n {\n \"vendorCode\": \"\",\n \"headerData\": {\n \"buyerReference\": \"\",\n \"orderReference\": \"\"\n },\n \"lineItems\": [\n {\n \"description\": \"\",\n \"accountType\": \"\",\n \"accountValue\": \"\",\n \"accountSecondaryValue\": \"\",\n \"vatPercent\": \"\",\n \"vatCode\": \"\",\n \"dimensions\": \"\"\n },\n {\n \"description\": \"\",\n \"accountType\": \"\",\n \"accountValue\": \"\",\n \"accountSecondaryValue\": \"\",\n \"vatPercent\": \"\",\n \"vatCode\": \"\",\n \"dimensions\": \"\"\n }\n ]\n },\n {\n \"vendorCode\": \"\",\n \"headerData\": {\n \"buyerReference\": \"\",\n \"orderReference\": \"\"\n },\n \"lineItems\": [\n {\n \"description\": \"\",\n \"accountType\": \"\",\n \"accountValue\": \"\",\n \"accountSecondaryValue\": \"\",\n \"vatPercent\": \"\",\n \"vatCode\": \"\",\n \"dimensions\": \"\"\n },\n {\n \"description\": \"\",\n \"accountType\": \"\",\n \"accountValue\": \"\",\n \"accountSecondaryValue\": \"\",\n \"vatPercent\": \"\",\n \"vatCode\": \"\",\n \"dimensions\": \"\"\n }\n ]\n }\n]" }, "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/inference/train", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "inference", "train" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Validation of model fails.", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "[\n {\n \"vendorCode\": \"\",\n \"headerData\": {\n \"buyerReference\": \"\",\n \"orderReference\": \"\"\n },\n \"lineItems\": [\n {\n \"description\": \"\",\n \"accountType\": \"\",\n \"accountValue\": \"\",\n \"accountSecondaryValue\": \"\",\n \"vatPercent\": \"\",\n \"vatCode\": \"\",\n \"dimensions\": \"\"\n },\n {\n \"description\": \"\",\n \"accountType\": \"\",\n \"accountValue\": \"\",\n \"accountSecondaryValue\": \"\",\n \"vatPercent\": \"\",\n \"vatCode\": \"\",\n \"dimensions\": \"\"\n }\n ]\n },\n {\n \"vendorCode\": \"\",\n \"headerData\": {\n \"buyerReference\": \"\",\n \"orderReference\": \"\"\n },\n \"lineItems\": [\n {\n \"description\": \"\",\n \"accountType\": \"\",\n \"accountValue\": \"\",\n \"accountSecondaryValue\": \"\",\n \"vatPercent\": \"\",\n \"vatCode\": \"\",\n \"dimensions\": \"\"\n },\n {\n \"description\": \"\",\n \"accountType\": \"\",\n \"accountValue\": \"\",\n \"accountSecondaryValue\": \"\",\n \"vatPercent\": \"\",\n \"vatCode\": \"\",\n \"dimensions\": \"\"\n }\n ]\n }\n]" }, "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/inference/train", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "inference", "train" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "If any network or client related error occurs.", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "[\n {\n \"vendorCode\": \"\",\n \"headerData\": {\n \"buyerReference\": \"\",\n \"orderReference\": \"\"\n },\n \"lineItems\": [\n {\n \"description\": \"\",\n \"accountType\": \"\",\n \"accountValue\": \"\",\n \"accountSecondaryValue\": \"\",\n \"vatPercent\": \"\",\n \"vatCode\": \"\",\n \"dimensions\": \"\"\n },\n {\n \"description\": \"\",\n \"accountType\": \"\",\n \"accountValue\": \"\",\n \"accountSecondaryValue\": \"\",\n \"vatPercent\": \"\",\n \"vatCode\": \"\",\n \"dimensions\": \"\"\n }\n ]\n },\n {\n \"vendorCode\": \"\",\n \"headerData\": {\n \"buyerReference\": \"\",\n \"orderReference\": \"\"\n },\n \"lineItems\": [\n {\n \"description\": \"\",\n \"accountType\": \"\",\n \"accountValue\": \"\",\n \"accountSecondaryValue\": \"\",\n \"vatPercent\": \"\",\n \"vatCode\": \"\",\n \"dimensions\": \"\"\n },\n {\n \"description\": \"\",\n \"accountType\": \"\",\n \"accountValue\": \"\",\n \"accountSecondaryValue\": \"\",\n \"vatPercent\": \"\",\n \"vatCode\": \"\",\n \"dimensions\": \"\"\n }\n ]\n }\n]" }, "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/inference/train", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "inference", "train" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\"\n}" } ] } ] }, { "name": "invoices", "item": [ { "name": "{invoice Id}", "item": [ { "name": "attachments", "item": [ { "name": "/invoices/:invoiceId/attachments", "request": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/invoices/:invoiceId/attachments", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "invoices", ":invoiceId", "attachments" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization id of the organization to which the invoice is related." }, { "key": "clientId", "value": "", "description": "(Required) Client id of the client to which the invoice is related." }, { "key": "invoiceId", "value": "", "description": "(Required) The id of the invoice to get attachments for." } ] }, "description": "Gets attachments information for a given invoice." }, "response": [ { "name": "The invoice with the given id can not be found.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/invoices/:invoiceId/attachments", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "invoices", ":invoiceId", "attachments" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" }, { "key": "invoiceId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "If security token is not provided or user not authenticated.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/invoices/:invoiceId/attachments", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "invoices", ":invoiceId", "attachments" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" }, { "key": "invoiceId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "If any network or client related error occurs.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/invoices/:invoiceId/attachments", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "invoices", ":invoiceId", "attachments" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" }, { "key": "invoiceId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\"\n}" }, { "name": "If user doesn't have permission to access this resource.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/invoices/:invoiceId/attachments", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "invoices", ":invoiceId", "attachments" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" }, { "key": "invoiceId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Attachments information about the requested invoice", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/invoices/:invoiceId/attachments", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "invoices", ":invoiceId", "attachments" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" }, { "key": "invoiceId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"id\": \"\",\n \"isInvoicePdf\": \"\",\n \"fileName\": \"\",\n \"pageCount\": \"\"\n },\n {\n \"id\": \"\",\n \"isInvoicePdf\": \"\",\n \"fileName\": \"\",\n \"pageCount\": \"\"\n }\n]" }, { "name": "If the request is malformed", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/invoices/:invoiceId/attachments", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "invoices", ":invoiceId", "attachments" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" }, { "key": "invoiceId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] }, { "name": "/invoices/:invoiceId/attachments/:attachmentId", "request": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/invoices/:invoiceId/attachments/:attachmentId", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "invoices", ":invoiceId", "attachments", ":attachmentId" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization id of the organization to which the invoice is related." }, { "key": "clientId", "value": "", "description": "(Required) Client id of the client to which the invoice is related." }, { "key": "invoiceId", "value": "", "description": "(Required) The id of the invoice to which the attachment is related." }, { "key": "attachmentId", "value": "", "description": "(Required) The id of the attachment" } ] }, "description": "Gets an attachment file for a given invoice." }, "response": [ { "name": "If the request is malformed", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/invoices/:invoiceId/attachments/:attachmentId", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "invoices", ":invoiceId", "attachments", ":attachmentId" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" }, { "key": "invoiceId" }, { "key": "attachmentId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "If user doesn't have permission to access this resource.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/invoices/:invoiceId/attachments/:attachmentId", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "invoices", ":invoiceId", "attachments", ":attachmentId" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" }, { "key": "invoiceId" }, { "key": "attachmentId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "If security token is not provided or user not authenticated.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/invoices/:invoiceId/attachments/:attachmentId", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "invoices", ":invoiceId", "attachments", ":attachmentId" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" }, { "key": "invoiceId" }, { "key": "attachmentId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "The invoice attachment file", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/invoices/:invoiceId/attachments/:attachmentId", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "invoices", ":invoiceId", "attachments", ":attachmentId" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" }, { "key": "invoiceId" }, { "key": "attachmentId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "The invoice or attachment with the given id can not be found.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/invoices/:invoiceId/attachments/:attachmentId", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "invoices", ":invoiceId", "attachments", ":attachmentId" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" }, { "key": "invoiceId" }, { "key": "attachmentId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "If any network or client related error occurs.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/invoices/:invoiceId/attachments/:attachmentId", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "invoices", ":invoiceId", "attachments", ":attachmentId" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" }, { "key": "invoiceId" }, { "key": "attachmentId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\"\n}" } ] } ] }, { "name": "/invoices/:invoiceId", "request": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/invoices/:invoiceId", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "invoices", ":invoiceId" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization id of the organization to which the invoice is related." }, { "key": "clientId", "value": "", "description": "(Required) Client id of the client to which the invoice is related." }, { "key": "invoiceId", "value": "", "description": "(Required) The id of the invoice to get details for" } ] }, "description": "Gets details for an invoice." }, "response": [ { "name": "The invoice with the given id can not be found", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/invoices/:invoiceId", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "invoices", ":invoiceId" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" }, { "key": "invoiceId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "The invoice details", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/invoices/:invoiceId", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "invoices", ":invoiceId" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" }, { "key": "invoiceId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"supplierIsApproved\": \"\",\n \"invoiceSourceType\": \"\",\n \"invoiceDate\": \"\",\n \"dueDate\": \"\",\n \"invoiceCurrency\": \"\",\n \"customerReference\": \"\",\n \"supplierReference\": \"\",\n \"purchaserName\": \"\",\n \"kidNumber\": \"\",\n \"voucherNumber\": \"\",\n \"paymentTerms\": \"\",\n \"buyerReference\": \"\",\n \"buyerContactPerson\": \"\",\n \"project\": \"\",\n \"department\": \"\",\n \"carPlateNumber\": \"\",\n \"orderReference\": \"\",\n \"doNotPay\": \"\",\n \"supplierNsAccount\": \"\",\n \"invoiceAmount\": {\n \"conversionRate\": \"\",\n \"conversionDate\": \"\",\n \"totalAmount\": \"\",\n \"balanceAmount\": \"\",\n \"vatAmount\": \"\",\n \"accountingLineTotalAmount\": \"\",\n \"accountingLineRemainingTotal\": \"\",\n \"netAmount\": \"\",\n \"reportingAmount\": \"\",\n \"roundingAmount\": \"\"\n },\n \"supplierParty\": {\n \"name\": \"\",\n \"vatNumber\": \"\",\n \"organizationNumber\": \"\",\n \"organizationNumberAuthority\": \"\",\n \"phone\": \"\",\n \"mobile\": \"\",\n \"web\": \"\",\n \"street\": \"\",\n \"zip\": \"\",\n \"country\": \"\",\n \"city\": \"\",\n \"bankAccountNumber\": \"\",\n \"ibanAccountNumber\": \"\"\n },\n \"customerParty\": {\n \"name\": \"\",\n \"vatNumber\": \"\",\n \"organizationNumber\": \"\",\n \"organizationNumberAuthority\": \"\",\n \"phone\": \"\",\n \"mobile\": \"\",\n \"web\": \"\",\n \"street\": \"\",\n \"zip\": \"\",\n \"country\": \"\",\n \"city\": \"\",\n \"bankAccountNumber\": \"\",\n \"ibanAccountNumber\": \"\"\n },\n \"buyer\": {\n \"email\": \"\",\n \"name\": \"\"\n },\n \"accountNumber\": \"\",\n \"purchaseOrderNumber\": \"\",\n \"isDeleted\": \"\",\n \"invoiceParameterValues\": [\n {\n \"invoiceId\": \"\",\n \"invoiceLineId\": \"\",\n \"invoiceParameterId\": \"\",\n \"stringValue\": \"\",\n \"boolValue\": \"\",\n \"integerValue\": \"\",\n \"decimalValue\": \"\"\n },\n {\n \"invoiceId\": \"\",\n \"invoiceLineId\": \"\",\n \"invoiceParameterId\": \"\",\n \"stringValue\": \"\",\n \"boolValue\": \"\",\n \"integerValue\": \"\",\n \"decimalValue\": \"\"\n }\n ],\n \"invoiceLines\": [\n {\n \"lineNumber\": \"\",\n \"invoiceLineNumber\": \"\",\n \"referenceLineNumber\": \"\",\n \"itemNumber\": \"\",\n \"description\": \"\",\n \"quantity\": \"\",\n \"unitPrice\": \"\",\n \"totalAmount\": \"\",\n \"discount\": \"\",\n \"vatRate\": \"\",\n \"vatAmount\": \"\",\n \"startPeriod\": \"\",\n \"totalPeriod\": \"\",\n \"startYear\": \"\",\n \"status\": \"\",\n \"text\": \"\",\n \"issueDate\": \"\",\n \"currency\": \"\",\n \"conversionRate\": \"\",\n \"isGroupingMasterLine\": \"\",\n \"ledgerType\": \"\",\n \"accountingParameters\": [\n {\n \"code\": \"\",\n \"parentCode\": \"\",\n \"type\": \"\"\n },\n {\n \"code\": \"\",\n \"parentCode\": \"\",\n \"type\": \"\"\n }\n ],\n \"invoiceParameterValues\": [\n {\n \"invoiceId\": \"\",\n \"invoiceLineId\": \"\",\n \"invoiceParameterId\": \"\",\n \"stringValue\": \"\",\n \"boolValue\": \"\",\n \"integerValue\": \"\",\n \"decimalValue\": \"\"\n },\n {\n \"invoiceId\": \"\",\n \"invoiceLineId\": \"\",\n \"invoiceParameterId\": \"\",\n \"stringValue\": \"\",\n \"boolValue\": \"\",\n \"integerValue\": \"\",\n \"decimalValue\": \"\"\n }\n ],\n \"parentInvoiceLine\": {\n \"value\": \"\"\n },\n \"childInvoiceLines\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"purchaseOrderDetails\": {\n \"purchaseOrderNumber\": \"\",\n \"purchaseOrderLineNumber\": \"\",\n \"categoryCode\": \"\",\n \"matchedQuantity\": \"\",\n \"unitPrice\": \"\",\n \"matchedNetAmount\": \"\",\n \"matchedTotalAmount\": \"\"\n },\n \"isDeleted\": \"\"\n },\n {\n \"lineNumber\": \"\",\n \"invoiceLineNumber\": \"\",\n \"referenceLineNumber\": \"\",\n \"itemNumber\": \"\",\n \"description\": \"\",\n \"quantity\": \"\",\n \"unitPrice\": \"\",\n \"totalAmount\": \"\",\n \"discount\": \"\",\n \"vatRate\": \"\",\n \"vatAmount\": \"\",\n \"startPeriod\": \"\",\n \"totalPeriod\": \"\",\n \"startYear\": \"\",\n \"status\": \"\",\n \"text\": \"\",\n \"issueDate\": \"\",\n \"currency\": \"\",\n \"conversionRate\": \"\",\n \"isGroupingMasterLine\": \"\",\n \"ledgerType\": \"\",\n \"accountingParameters\": [\n {\n \"code\": \"\",\n \"parentCode\": \"\",\n \"type\": \"\"\n },\n {\n \"code\": \"\",\n \"parentCode\": \"\",\n \"type\": \"\"\n }\n ],\n \"invoiceParameterValues\": [\n {\n \"invoiceId\": \"\",\n \"invoiceLineId\": \"\",\n \"invoiceParameterId\": \"\",\n \"stringValue\": \"\",\n \"boolValue\": \"\",\n \"integerValue\": \"\",\n \"decimalValue\": \"\"\n },\n {\n \"invoiceId\": \"\",\n \"invoiceLineId\": \"\",\n \"invoiceParameterId\": \"\",\n \"stringValue\": \"\",\n \"boolValue\": \"\",\n \"integerValue\": \"\",\n \"decimalValue\": \"\"\n }\n ],\n \"parentInvoiceLine\": {\n \"value\": \"\"\n },\n \"childInvoiceLines\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"purchaseOrderDetails\": {\n \"purchaseOrderNumber\": \"\",\n \"purchaseOrderLineNumber\": \"\",\n \"categoryCode\": \"\",\n \"matchedQuantity\": \"\",\n \"unitPrice\": \"\",\n \"matchedNetAmount\": \"\",\n \"matchedTotalAmount\": \"\"\n },\n \"isDeleted\": \"\"\n }\n ],\n \"purchaseInvoiceLines\": [\n {\n \"invoiceLineId\": \"\",\n \"invoiceLineCategoryCode\": \"\",\n \"purchaseOrderNumber\": \"\",\n \"purchaseOrderLineNumber\": \"\",\n \"purchaseOrderLineQuantityMatched\": \"\",\n \"purchaseOrderLineUnitPrice\": \"\",\n \"purchaseOrderLineMatchedNetAmount\": \"\",\n \"purchaseOrderLineMatchedTotalAmount\": \"\",\n \"invoiceLineTotalAmount\": \"\",\n \"invoiceLineAccountingParameterValues\": [\n {\n \"parameterCode\": \"\",\n \"parameterExternalCode\": \"\",\n \"parameterValueCode\": \"\",\n \"parameterTypeCode\": \"\"\n },\n {\n \"parameterCode\": \"\",\n \"parameterExternalCode\": \"\",\n \"parameterValueCode\": \"\",\n \"parameterTypeCode\": \"\"\n }\n ]\n },\n {\n \"invoiceLineId\": \"\",\n \"invoiceLineCategoryCode\": \"\",\n \"purchaseOrderNumber\": \"\",\n \"purchaseOrderLineNumber\": \"\",\n \"purchaseOrderLineQuantityMatched\": \"\",\n \"purchaseOrderLineUnitPrice\": \"\",\n \"purchaseOrderLineMatchedNetAmount\": \"\",\n \"purchaseOrderLineMatchedTotalAmount\": \"\",\n \"invoiceLineTotalAmount\": \"\",\n \"invoiceLineAccountingParameterValues\": [\n {\n \"parameterCode\": \"\",\n \"parameterExternalCode\": \"\",\n \"parameterValueCode\": \"\",\n \"parameterTypeCode\": \"\"\n },\n {\n \"parameterCode\": \"\",\n \"parameterExternalCode\": \"\",\n \"parameterValueCode\": \"\",\n \"parameterTypeCode\": \"\"\n }\n ]\n }\n ],\n \"attachments\": [\n {\n \"id\": \"\",\n \"isInvoicePdf\": \"\",\n \"fileName\": \"\",\n \"pageCount\": \"\"\n },\n {\n \"id\": \"\",\n \"isInvoicePdf\": \"\",\n \"fileName\": \"\",\n \"pageCount\": \"\"\n }\n ],\n \"taxDetails\": [\n {\n \"currency\": \"\",\n \"taxRate\": \"\",\n \"taxAmount\": \"\",\n \"taxCategory\": \"\",\n \"taxExemptionReason\": \"\",\n \"taxType\": \"\"\n },\n {\n \"currency\": \"\",\n \"taxRate\": \"\",\n \"taxAmount\": \"\",\n \"taxCategory\": \"\",\n \"taxExemptionReason\": \"\",\n \"taxType\": \"\"\n }\n ],\n \"invoiceAccountingLines\": [\n {\n \"postingDate\": \"\",\n \"description\": \"\",\n \"lineType\": \"\",\n \"issueDate\": \"\",\n \"currency\": \"\",\n \"netAmount\": \"\",\n \"totalAmount\": \"\",\n \"grossAmount\": \"\",\n \"vatAmount\": \"\",\n \"exchangeRate\": \"\",\n \"lineNumber\": \"\",\n \"discount\": \"\",\n \"debitLedgerType\": \"\",\n \"creditLedgerType\": \"\",\n \"invoiceAccountingLineParameters\": [\n {\n \"code\": \"\",\n \"parentCode\": \"\",\n \"type\": \"\",\n \"payableType\": \"\"\n },\n {\n \"code\": \"\",\n \"parentCode\": \"\",\n \"type\": \"\",\n \"payableType\": \"\"\n }\n ]\n },\n {\n \"postingDate\": \"\",\n \"description\": \"\",\n \"lineType\": \"\",\n \"issueDate\": \"\",\n \"currency\": \"\",\n \"netAmount\": \"\",\n \"totalAmount\": \"\",\n \"grossAmount\": \"\",\n \"vatAmount\": \"\",\n \"exchangeRate\": \"\",\n \"lineNumber\": \"\",\n \"discount\": \"\",\n \"debitLedgerType\": \"\",\n \"creditLedgerType\": \"\",\n \"invoiceAccountingLineParameters\": [\n {\n \"code\": \"\",\n \"parentCode\": \"\",\n \"type\": \"\",\n \"payableType\": \"\"\n },\n {\n \"code\": \"\",\n \"parentCode\": \"\",\n \"type\": \"\",\n \"payableType\": \"\"\n }\n ]\n }\n ],\n \"invoiceId\": \"\",\n \"organizationId\": \"\",\n \"datasetId\": \"\",\n \"clientId\": \"\",\n \"externalClientId\": \"\",\n \"invoiceNumber\": \"\",\n \"documentType\": \"\",\n \"supplier\": {\n \"code\": \"\",\n \"name\": \"\",\n \"organizationNumber\": \"\",\n \"bankAccount\": \"\"\n },\n \"invoiceType\": \"\",\n \"invoiceStatus\": \"\",\n \"semineUrl\": \"\"\n}" }, { "name": "If the request is malformed", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/invoices/:invoiceId", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "invoices", ":invoiceId" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" }, { "key": "invoiceId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "If security token is not provided or user not authenticated.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/invoices/:invoiceId", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "invoices", ":invoiceId" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" }, { "key": "invoiceId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "If any network or client related error occurs.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/invoices/:invoiceId", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "invoices", ":invoiceId" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" }, { "key": "invoiceId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\"\n}" }, { "name": "If user doesn't have permission to access this resource.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/invoices/:invoiceId", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "invoices", ":invoiceId" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" }, { "key": "invoiceId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] }, { "name": "/invoices/:invoiceId/ubl", "request": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/invoices/:invoiceId/ubl", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "invoices", ":invoiceId", "ubl" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization id of the organization to which the invoice is related." }, { "key": "clientId", "value": "", "description": "(Required) Client id of the client to which the invoice is related." }, { "key": "invoiceId", "value": "", "description": "(Required) The id of the invoice to get UBL for" } ] }, "description": "Gets UBL for an invoice." }, "response": [ { "name": "If the request is malformed", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/invoices/:invoiceId/ubl", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "invoices", ":invoiceId", "ubl" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" }, { "key": "invoiceId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "The invoice with the given id can not be found.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/invoices/:invoiceId/ubl", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "invoices", ":invoiceId", "ubl" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" }, { "key": "invoiceId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "If any network or client related error occurs.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/invoices/:invoiceId/ubl", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "invoices", ":invoiceId", "ubl" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" }, { "key": "invoiceId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\"\n}" }, { "name": "The invoice UBL", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/invoices/:invoiceId/ubl", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "invoices", ":invoiceId", "ubl" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" }, { "key": "invoiceId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "If security token is not provided or user not authenticated.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/invoices/:invoiceId/ubl", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "invoices", ":invoiceId", "ubl" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" }, { "key": "invoiceId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "If user doesn't have permission to access this resource.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/invoices/:invoiceId/ubl", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "invoices", ":invoiceId", "ubl" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" }, { "key": "invoiceId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] }, { "name": "/invoices/:invoiceId/pdf", "request": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/invoices/:invoiceId/pdf", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "invoices", ":invoiceId", "pdf" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization id of the organization to which the invoice is related." }, { "key": "clientId", "value": "", "description": "(Required) Client id of the client to which the invoice is related." }, { "key": "invoiceId", "value": "", "description": "(Required) The id of the invoice to get the PDF file for" } ] }, "description": "Gets the PDF file for an invoice." }, "response": [ { "name": "If user doesn't have permission to access this resource.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/invoices/:invoiceId/pdf", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "invoices", ":invoiceId", "pdf" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" }, { "key": "invoiceId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "If any network or client related error occurs.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/invoices/:invoiceId/pdf", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "invoices", ":invoiceId", "pdf" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" }, { "key": "invoiceId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\"\n}" }, { "name": "If the request is malformed", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/invoices/:invoiceId/pdf", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "invoices", ":invoiceId", "pdf" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" }, { "key": "invoiceId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "The invoice with the given id can not be found.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/invoices/:invoiceId/pdf", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "invoices", ":invoiceId", "pdf" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" }, { "key": "invoiceId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "If security token is not provided or user not authenticated.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/invoices/:invoiceId/pdf", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "invoices", ":invoiceId", "pdf" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" }, { "key": "invoiceId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "The invoice PDF file", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/invoices/:invoiceId/pdf", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "invoices", ":invoiceId", "pdf" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" }, { "key": "invoiceId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] }, { "name": "/invoices/:invoiceId/status", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"status\": \"\"\n}" }, "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/invoices/:invoiceId/status", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "invoices", ":invoiceId", "status" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization id of the organization to which the invoice is related." }, { "key": "clientId", "value": "", "description": "(Required) Client id of the client to which the invoice is related." }, { "key": "invoiceId", "value": "", "description": "(Required) The id of the invoice to update status for." } ] }, "description": "Updates the status for a given invoice. Currently it is only allowed to set status Posted on an invoice that is in state Posting." }, "response": [ { "name": "If the request is malformed", "originalRequest": { "method": "PUT", "header": [], "body": { "mode": "raw", "raw": "{\n \"status\": \"\"\n}" }, "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/invoices/:invoiceId/status", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "invoices", ":invoiceId", "status" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" }, { "key": "invoiceId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "If any network or client related error occurs.", "originalRequest": { "method": "PUT", "header": [], "body": { "mode": "raw", "raw": "{\n \"status\": \"\"\n}" }, "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/invoices/:invoiceId/status", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "invoices", ":invoiceId", "status" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" }, { "key": "invoiceId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\"\n}" }, { "name": "If security token is not provided or user not authenticated.", "originalRequest": { "method": "PUT", "header": [], "body": { "mode": "raw", "raw": "{\n \"status\": \"\"\n}" }, "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/invoices/:invoiceId/status", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "invoices", ":invoiceId", "status" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" }, { "key": "invoiceId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Not sure yet", "originalRequest": { "method": "PUT", "header": [], "body": { "mode": "raw", "raw": "{\n \"status\": \"\"\n}" }, "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/invoices/:invoiceId/status", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "invoices", ":invoiceId", "status" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" }, { "key": "invoiceId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "If user doesn't have permission to access this resource.", "originalRequest": { "method": "PUT", "header": [], "body": { "mode": "raw", "raw": "{\n \"status\": \"\"\n}" }, "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/invoices/:invoiceId/status", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "invoices", ":invoiceId", "status" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" }, { "key": "invoiceId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "The invoice with the given id can not be found.", "originalRequest": { "method": "PUT", "header": [], "body": { "mode": "raw", "raw": "{\n \"status\": \"\"\n}" }, "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/invoices/:invoiceId/status", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "invoices", ":invoiceId", "status" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" }, { "key": "invoiceId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] } ] }, { "name": "/invoices", "request": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/invoices", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "invoices" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization id of the organization to which the invoices ready for posting are related." }, { "key": "clientId", "value": "", "description": "(Required) Client id of the client to which the invoices ready for posting are related." } ] }, "description": "Gets all invoices ready for posting for a client." }, "response": [ { "name": "The invoices ready for posting", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/invoices", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "invoices" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"invoiceId\": \"\",\n \"organizationId\": \"\",\n \"datasetId\": \"\",\n \"clientId\": \"\",\n \"externalClientId\": \"\",\n \"invoiceNumber\": \"\",\n \"documentType\": \"\",\n \"supplier\": {\n \"code\": \"\",\n \"name\": \"\",\n \"organizationNumber\": \"\",\n \"bankAccount\": \"\"\n },\n \"invoiceType\": \"\",\n \"invoiceStatus\": \"\",\n \"semineUrl\": \"\"\n },\n {\n \"invoiceId\": \"\",\n \"organizationId\": \"\",\n \"datasetId\": \"\",\n \"clientId\": \"\",\n \"externalClientId\": \"\",\n \"invoiceNumber\": \"\",\n \"documentType\": \"\",\n \"supplier\": {\n \"code\": \"\",\n \"name\": \"\",\n \"organizationNumber\": \"\",\n \"bankAccount\": \"\"\n },\n \"invoiceType\": \"\",\n \"invoiceStatus\": \"\",\n \"semineUrl\": \"\"\n }\n]" }, { "name": "If the request is malformed", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/invoices", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "invoices" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "If any network or client related error occurs.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/invoices", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "invoices" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\"\n}" }, { "name": "No invoices are ready for posting", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/invoices", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "invoices" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "If user doesn't have permission to access this resource.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/invoices", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "invoices" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "If security token is not provided or user not authenticated.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/invoices", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "invoices" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] } ] }, { "name": "settings", "item": [ { "name": "/settings", "request": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/settings", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "settings" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) The organization id to which the client belong." }, { "key": "clientId", "value": "", "description": "(Required) The client id of the client to get settings for." } ] }, "description": "Gets all settings for a given client." }, "response": [ { "name": "If security token is not provided or user not authenticated.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/settings", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "settings" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "If user doesn't have permission to access this resource.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/settings", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "settings" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "The settings for the client was fetched successfully", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/settings", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "settings" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"settingKey\": \"\",\n \"dataType\": \"\",\n \"stringValue\": \"\",\n \"integerValue\": \"\",\n \"booleanValue\": \"\",\n \"decimalValue\": \"\",\n \"dateTimeValue\": \"\",\n \"guidValue\": \"\"\n },\n {\n \"settingKey\": \"\",\n \"dataType\": \"\",\n \"stringValue\": \"\",\n \"integerValue\": \"\",\n \"booleanValue\": \"\",\n \"decimalValue\": \"\",\n \"dateTimeValue\": \"\",\n \"guidValue\": \"\"\n }\n]" }, { "name": "If any network or client related error occurs.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/settings", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "settings" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\"\n}" }, { "name": "If the request is malformed", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/settings", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "settings" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "No settings were found for the given organization", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/settings", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "settings" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] }, { "name": "/settings", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"settingKey\": \"\",\n \"dataType\": \"\",\n \"stringValue\": \"\",\n \"integerValue\": \"\",\n \"booleanValue\": \"\",\n \"decimalValue\": \"\",\n \"dateTimeValue\": \"\",\n \"guidValue\": \"\"\n}" }, "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/settings", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "settings" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) The organization id to which the client belong." }, { "key": "clientId", "value": "", "description": "(Required) The client id of the client to add or update the setting for." } ] }, "description": "Adds or updates a setting for a given client." }, "response": [ { "name": "If user doesn't have permission to access this resource.", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"settingKey\": \"\",\n \"dataType\": \"\",\n \"stringValue\": \"\",\n \"integerValue\": \"\",\n \"booleanValue\": \"\",\n \"decimalValue\": \"\",\n \"dateTimeValue\": \"\",\n \"guidValue\": \"\"\n}" }, "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/settings", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "settings" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "The setting was added or updated successfully", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"settingKey\": \"\",\n \"dataType\": \"\",\n \"stringValue\": \"\",\n \"integerValue\": \"\",\n \"booleanValue\": \"\",\n \"decimalValue\": \"\",\n \"dateTimeValue\": \"\",\n \"guidValue\": \"\"\n}" }, "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/settings", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "settings" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"settingKey\": \"\",\n \"dataType\": \"\",\n \"stringValue\": \"\",\n \"integerValue\": \"\",\n \"booleanValue\": \"\",\n \"decimalValue\": \"\",\n \"dateTimeValue\": \"\",\n \"guidValue\": \"\"\n}" }, { "name": "If security token is not provided or user not authenticated.", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"settingKey\": \"\",\n \"dataType\": \"\",\n \"stringValue\": \"\",\n \"integerValue\": \"\",\n \"booleanValue\": \"\",\n \"decimalValue\": \"\",\n \"dateTimeValue\": \"\",\n \"guidValue\": \"\"\n}" }, "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/settings", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "settings" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "If any network or client related error occurs.", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"settingKey\": \"\",\n \"dataType\": \"\",\n \"stringValue\": \"\",\n \"integerValue\": \"\",\n \"booleanValue\": \"\",\n \"decimalValue\": \"\",\n \"dateTimeValue\": \"\",\n \"guidValue\": \"\"\n}" }, "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/settings", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "settings" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\"\n}" }, { "name": "If the request is malformed", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"settingKey\": \"\",\n \"dataType\": \"\",\n \"stringValue\": \"\",\n \"integerValue\": \"\",\n \"booleanValue\": \"\",\n \"decimalValue\": \"\",\n \"dateTimeValue\": \"\",\n \"guidValue\": \"\"\n}" }, "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/settings", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "settings" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] }, { "name": "/settings/:settingKey", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/settings/:settingKey", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "settings", ":settingKey" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) The organization id to which the client belong." }, { "key": "clientId", "value": "", "description": "(Required) The client id of the client the setting is connected to." }, { "key": "settingKey", "value": "", "description": "(Required) The key of the setting to remove from the client." } ] }, "description": "Deletes a setting for a given client." }, "response": [ { "name": "If security token is not provided or user not authenticated.", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/settings/:settingKey", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "settings", ":settingKey" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" }, { "key": "settingKey" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "If user doesn't have permission to access this resource.", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/settings/:settingKey", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "settings", ":settingKey" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" }, { "key": "settingKey" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "The setting was deleted successfully", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/settings/:settingKey", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "settings", ":settingKey" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" }, { "key": "settingKey" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"settingKey\": \"\",\n \"dataType\": \"\",\n \"stringValue\": \"\",\n \"integerValue\": \"\",\n \"booleanValue\": \"\",\n \"decimalValue\": \"\",\n \"dateTimeValue\": \"\",\n \"guidValue\": \"\"\n}" }, { "name": "If the request is malformed", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/settings/:settingKey", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "settings", ":settingKey" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" }, { "key": "settingKey" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "If any network or client related error occurs.", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/settings/:settingKey", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "settings", ":settingKey" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" }, { "key": "settingKey" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\"\n}" } ] } ] }, { "name": "projects", "item": [ { "name": "{code}", "item": [ { "name": "/projects/:code", "request": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/projects/:code", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "projects", ":code" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization id of the organization to which the project is related." }, { "key": "clientId", "value": "", "description": "(Required) Client id of the client to which the project is related." }, { "key": "code", "value": "", "description": "(Required) The ERP code for the project" } ] }, "description": "Gets a project object based on the ERP code." }, "response": [ { "name": "The project for the given client with requested code", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/projects/:code", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "projects", ":code" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" }, { "key": "code" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"\",\n \"status\": \"\",\n \"relations\": [\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n },\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n }\n ],\n \"description\": [\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n },\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n }\n ]\n}" }, { "name": "Validation of model fails.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/projects/:code", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "projects", ":code" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" }, { "key": "code" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "If user doesn't have permission to access this resource.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/projects/:code", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "projects", ":code" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" }, { "key": "code" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "If security token is not provided or user not authenticated.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/projects/:code", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "projects", ":code" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" }, { "key": "code" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "If any network or client related error occurs.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/projects/:code", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "projects", ":code" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" }, { "key": "code" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\"\n}" }, { "name": "Project does not exist.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/projects/:code", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "projects", ":code" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" }, { "key": "code" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] }, { "name": "/projects/:code", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/projects/:code", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "projects", ":code" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization id of the organization to which the project is related." }, { "key": "clientId", "value": "", "description": "(Required) Client id of the client to which the project is related." }, { "key": "code", "value": "", "description": "(Required) The ERP code of the project to delete" } ] }, "description": "Delete a project" }, "response": [ { "name": "Validation of model fails.", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/projects/:code", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "projects", ":code" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" }, { "key": "code" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "The project has been deleted successfully", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/projects/:code", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "projects", ":code" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" }, { "key": "code" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"\",\n \"status\": \"\",\n \"relations\": [\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n },\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n }\n ],\n \"description\": [\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n },\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n }\n ]\n}" }, { "name": "If security token is not provided or user not authenticated.", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/projects/:code", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "projects", ":code" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" }, { "key": "code" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "If any network or client related error occurs.", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/projects/:code", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "projects", ":code" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" }, { "key": "code" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\"\n}" }, { "name": "If user doesn't have permission to access this resource.", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/projects/:code", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "projects", ":code" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" }, { "key": "code" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] } ] }, { "name": "/projects", "request": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/projects?textSearch=", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "projects" ], "query": [ { "key": "textSearch", "value": "", "description": "Optional search for text in codes or descriptions" } ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization id of the organization to which the projects are related." }, { "key": "clientId", "value": "", "description": "(Required) Client id of the client to which the projects are related." } ] }, "description": "Gets all projects for a client." }, "response": [ { "name": "Validation of model fails.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/projects?textSearch=", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "projects" ], "query": [ { "key": "textSearch", "value": "" } ], "variable": [ { "key": "organizationId" }, { "key": "clientId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "The projects for the given client", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/projects?textSearch=", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "projects" ], "query": [ { "key": "textSearch", "value": "" } ], "variable": [ { "key": "organizationId" }, { "key": "clientId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"code\": \"\",\n \"status\": \"\",\n \"relations\": [\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n },\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n }\n ],\n \"description\": [\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n },\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n }\n ]\n },\n {\n \"code\": \"\",\n \"status\": \"\",\n \"relations\": [\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n },\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n }\n ],\n \"description\": [\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n },\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n }\n ]\n }\n]" }, { "name": "No projects exist for the given client", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/projects?textSearch=", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "projects" ], "query": [ { "key": "textSearch", "value": "" } ], "variable": [ { "key": "organizationId" }, { "key": "clientId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "If security token is not provided or user not authenticated.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/projects?textSearch=", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "projects" ], "query": [ { "key": "textSearch", "value": "" } ], "variable": [ { "key": "organizationId" }, { "key": "clientId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "If user doesn't have permission to access this resource.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/projects?textSearch=", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "projects" ], "query": [ { "key": "textSearch", "value": "" } ], "variable": [ { "key": "organizationId" }, { "key": "clientId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "If any network or client related error occurs.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/projects?textSearch=", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "projects" ], "query": [ { "key": "textSearch", "value": "" } ], "variable": [ { "key": "organizationId" }, { "key": "clientId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\"\n}" } ] }, { "name": "/projects", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "[\n {\n \"code\": \"\",\n \"status\": \"\",\n \"relations\": [\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n },\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n }\n ],\n \"description\": [\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n },\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n }\n ]\n },\n {\n \"code\": \"\",\n \"status\": \"\",\n \"relations\": [\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n },\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n }\n ],\n \"description\": [\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n },\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n }\n ]\n }\n]" }, "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/projects", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "projects" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization id of the organization to which the projects are related." }, { "key": "clientId", "value": "", "description": "(Required) Client id of the client to which the projects are related." } ] }, "description": "Inserts and updates projects for a given client" }, "response": [ { "name": "Validation of model fails.", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "[\n {\n \"code\": \"\",\n \"status\": \"\",\n \"relations\": [\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n },\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n }\n ],\n \"description\": [\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n },\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n }\n ]\n },\n {\n \"code\": \"\",\n \"status\": \"\",\n \"relations\": [\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n },\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n }\n ],\n \"description\": [\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n },\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n }\n ]\n }\n]" }, "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/projects", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "projects" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "If security token is not provided or user not authenticated.", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "[\n {\n \"code\": \"\",\n \"status\": \"\",\n \"relations\": [\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n },\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n }\n ],\n \"description\": [\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n },\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n }\n ]\n },\n {\n \"code\": \"\",\n \"status\": \"\",\n \"relations\": [\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n },\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n }\n ],\n \"description\": [\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n },\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n }\n ]\n }\n]" }, "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/projects", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "projects" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "If user doesn't have permission to access this resource.", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "[\n {\n \"code\": \"\",\n \"status\": \"\",\n \"relations\": [\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n },\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n }\n ],\n \"description\": [\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n },\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n }\n ]\n },\n {\n \"code\": \"\",\n \"status\": \"\",\n \"relations\": [\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n },\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n }\n ],\n \"description\": [\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n },\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n }\n ]\n }\n]" }, "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/projects", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "projects" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "If any network or client related error occurs.", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "[\n {\n \"code\": \"\",\n \"status\": \"\",\n \"relations\": [\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n },\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n }\n ],\n \"description\": [\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n },\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n }\n ]\n },\n {\n \"code\": \"\",\n \"status\": \"\",\n \"relations\": [\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n },\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n }\n ],\n \"description\": [\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n },\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n }\n ]\n }\n]" }, "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/projects", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "projects" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\"\n}" }, { "name": "The projects have been processed successfully", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "[\n {\n \"code\": \"\",\n \"status\": \"\",\n \"relations\": [\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n },\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n }\n ],\n \"description\": [\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n },\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n }\n ]\n },\n {\n \"code\": \"\",\n \"status\": \"\",\n \"relations\": [\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n },\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n }\n ],\n \"description\": [\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n },\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n }\n ]\n }\n]" }, "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/projects", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "projects" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"failed\": [\n {\n \"item\": {\n \"code\": \"\",\n \"status\": \"\",\n \"relations\": [\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n },\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n }\n ],\n \"description\": [\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n },\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n }\n ]\n },\n \"message\": \"\"\n },\n {\n \"item\": {\n \"code\": \"\",\n \"status\": \"\",\n \"relations\": [\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n },\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n }\n ],\n \"description\": [\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n },\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n }\n ]\n },\n \"message\": \"\"\n }\n ]\n}" } ] } ] }, { "name": "purchase Orders", "item": [ { "name": "categories", "item": [ { "name": "/purchaseOrders/categories", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "[\n {\n \"categoryCode\": \"\",\n \"description\": \"\"\n },\n {\n \"categoryCode\": \"\",\n \"description\": \"\"\n }\n]" }, "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/purchaseOrders/categories", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "purchaseOrders", "categories" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization id of which this purchase order is related to." }, { "key": "clientId", "value": "", "description": "(Required) Client id of which this purchase order is related to." } ] }, "description": "Inserts/updates categories lookup tables related to customer - organization - client.\r\nIf provided list is empty, then all previous categories related to client are removed.\r\nOtherwise given list will replace the previous list" }, "response": [ { "name": "If any network or client related error occurs.", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "[\n {\n \"categoryCode\": \"\",\n \"description\": \"\"\n },\n {\n \"categoryCode\": \"\",\n \"description\": \"\"\n }\n]" }, "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/purchaseOrders/categories", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "purchaseOrders", "categories" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\"\n}" }, { "name": "If any validation fails for both purchase order metadata and purchase order lines.", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "[\n {\n \"categoryCode\": \"\",\n \"description\": \"\"\n },\n {\n \"categoryCode\": \"\",\n \"description\": \"\"\n }\n]" }, "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/purchaseOrders/categories", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "purchaseOrders", "categories" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "With a message containing updated categories\".", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "[\n {\n \"categoryCode\": \"\",\n \"description\": \"\"\n },\n {\n \"categoryCode\": \"\",\n \"description\": \"\"\n }\n]" }, "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/purchaseOrders/categories", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "purchaseOrders", "categories" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"categoryCode\": \"\",\n \"description\": \"\"\n },\n {\n \"categoryCode\": \"\",\n \"description\": \"\"\n }\n]" }, { "name": "If user doesn't have permission to access this resource.", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "[\n {\n \"categoryCode\": \"\",\n \"description\": \"\"\n },\n {\n \"categoryCode\": \"\",\n \"description\": \"\"\n }\n]" }, "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/purchaseOrders/categories", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "purchaseOrders", "categories" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "If security token is not provided or user not authenticated.", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "[\n {\n \"categoryCode\": \"\",\n \"description\": \"\"\n },\n {\n \"categoryCode\": \"\",\n \"description\": \"\"\n }\n]" }, "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/purchaseOrders/categories", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "purchaseOrders", "categories" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] }, { "name": "/purchaseOrders/categories", "request": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/purchaseOrders/categories", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "purchaseOrders", "categories" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization id of which this purchase order is related to." }, { "key": "clientId", "value": "", "description": "(Required) Client id of which this purchase order is related to." } ] }, "description": "Lists categories lookup tables related to customer - organization - client." }, "response": [ { "name": "If user doesn't have permission to access this resource.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/purchaseOrders/categories", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "purchaseOrders", "categories" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "If any validation fails for both purchase order metadata and purchase order lines.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/purchaseOrders/categories", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "purchaseOrders", "categories" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "With a message containing updated categories\".", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/purchaseOrders/categories", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "purchaseOrders", "categories" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"categoryCode\": \"\",\n \"description\": \"\"\n },\n {\n \"categoryCode\": \"\",\n \"description\": \"\"\n }\n]" }, { "name": "If security token is not provided or user not authenticated.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/purchaseOrders/categories", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "purchaseOrders", "categories" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "If any network or client related error occurs.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/purchaseOrders/categories", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "purchaseOrders", "categories" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\"\n}" } ] } ] }, { "name": "/purchaseOrders", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"currency\": \"\",\n \"erpVendorId\": \"\",\n \"purchaseOrderNumber\": \"\",\n \"status\": \"\",\n \"orderDate\": \"\",\n \"purchaser\": \"\",\n \"purchaseOrderLines\": [\n {\n \"purchaseOrderLineNumber\": \"\",\n \"quantityInvoiced\": \"\",\n \"quantityOrdered\": \"\",\n \"quantityReceived\": \"\",\n \"quantityRemaining\": \"\",\n \"status\": \"\",\n \"supplierItemNumber\": \"\",\n \"customerItemNumber\": \"\",\n \"description\": \"\",\n \"unitPrice\": \"\",\n \"unit\": \"\",\n \"vatPercentage\": \"\",\n \"netAmount\": \"\",\n \"discountPercentage\": \"\",\n \"discountAmount\": \"\",\n \"totalAmount\": \"\",\n \"receivedNetAmount\": \"\",\n \"lastReceived\": \"\",\n \"categoryCode\": \"\",\n \"accountingParameters\": [\n {\n \"parameterCode\": \"\",\n \"parameterType\": \"\",\n \"parameterValueCode\": \"\"\n },\n {\n \"parameterCode\": \"\",\n \"parameterType\": \"\",\n \"parameterValueCode\": \"\"\n }\n ]\n },\n {\n \"purchaseOrderLineNumber\": \"\",\n \"quantityInvoiced\": \"\",\n \"quantityOrdered\": \"\",\n \"quantityReceived\": \"\",\n \"quantityRemaining\": \"\",\n \"status\": \"\",\n \"supplierItemNumber\": \"\",\n \"customerItemNumber\": \"\",\n \"description\": \"\",\n \"unitPrice\": \"\",\n \"unit\": \"\",\n \"vatPercentage\": \"\",\n \"netAmount\": \"\",\n \"discountPercentage\": \"\",\n \"discountAmount\": \"\",\n \"totalAmount\": \"\",\n \"receivedNetAmount\": \"\",\n \"lastReceived\": \"\",\n \"categoryCode\": \"\",\n \"accountingParameters\": [\n {\n \"parameterCode\": \"\",\n \"parameterType\": \"\",\n \"parameterValueCode\": \"\"\n },\n {\n \"parameterCode\": \"\",\n \"parameterType\": \"\",\n \"parameterValueCode\": \"\"\n }\n ]\n }\n ],\n \"categoryCode\": \"\"\n}" }, "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/purchaseOrders", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "purchaseOrders" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization id of which this purchase order is related to." }, { "key": "clientId", "value": "", "description": "(Required) Client id of which this purchase order is related to." } ] }, "description": "Inserts/Updates the given purchase order object and related purchase order line items. If the purchase order object with given PurchaseOrderId already exists, then it updates and overrides to the previous one." }, "response": [ { "name": "With a message \"insert/Update message sent!\"", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"currency\": \"\",\n \"erpVendorId\": \"\",\n \"purchaseOrderNumber\": \"\",\n \"status\": \"\",\n \"orderDate\": \"\",\n \"purchaser\": \"\",\n \"purchaseOrderLines\": [\n {\n \"purchaseOrderLineNumber\": \"\",\n \"quantityInvoiced\": \"\",\n \"quantityOrdered\": \"\",\n \"quantityReceived\": \"\",\n \"quantityRemaining\": \"\",\n \"status\": \"\",\n \"supplierItemNumber\": \"\",\n \"customerItemNumber\": \"\",\n \"description\": \"\",\n \"unitPrice\": \"\",\n \"unit\": \"\",\n \"vatPercentage\": \"\",\n \"netAmount\": \"\",\n \"discountPercentage\": \"\",\n \"discountAmount\": \"\",\n \"totalAmount\": \"\",\n \"receivedNetAmount\": \"\",\n \"lastReceived\": \"\",\n \"categoryCode\": \"\",\n \"accountingParameters\": [\n {\n \"parameterCode\": \"\",\n \"parameterType\": \"\",\n \"parameterValueCode\": \"\"\n },\n {\n \"parameterCode\": \"\",\n \"parameterType\": \"\",\n \"parameterValueCode\": \"\"\n }\n ]\n },\n {\n \"purchaseOrderLineNumber\": \"\",\n \"quantityInvoiced\": \"\",\n \"quantityOrdered\": \"\",\n \"quantityReceived\": \"\",\n \"quantityRemaining\": \"\",\n \"status\": \"\",\n \"supplierItemNumber\": \"\",\n \"customerItemNumber\": \"\",\n \"description\": \"\",\n \"unitPrice\": \"\",\n \"unit\": \"\",\n \"vatPercentage\": \"\",\n \"netAmount\": \"\",\n \"discountPercentage\": \"\",\n \"discountAmount\": \"\",\n \"totalAmount\": \"\",\n \"receivedNetAmount\": \"\",\n \"lastReceived\": \"\",\n \"categoryCode\": \"\",\n \"accountingParameters\": [\n {\n \"parameterCode\": \"\",\n \"parameterType\": \"\",\n \"parameterValueCode\": \"\"\n },\n {\n \"parameterCode\": \"\",\n \"parameterType\": \"\",\n \"parameterValueCode\": \"\"\n }\n ]\n }\n ],\n \"categoryCode\": \"\"\n}" }, "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/purchaseOrders", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "purchaseOrders" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "If security token is not provided or user not authenticated.", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"currency\": \"\",\n \"erpVendorId\": \"\",\n \"purchaseOrderNumber\": \"\",\n \"status\": \"\",\n \"orderDate\": \"\",\n \"purchaser\": \"\",\n \"purchaseOrderLines\": [\n {\n \"purchaseOrderLineNumber\": \"\",\n \"quantityInvoiced\": \"\",\n \"quantityOrdered\": \"\",\n \"quantityReceived\": \"\",\n \"quantityRemaining\": \"\",\n \"status\": \"\",\n \"supplierItemNumber\": \"\",\n \"customerItemNumber\": \"\",\n \"description\": \"\",\n \"unitPrice\": \"\",\n \"unit\": \"\",\n \"vatPercentage\": \"\",\n \"netAmount\": \"\",\n \"discountPercentage\": \"\",\n \"discountAmount\": \"\",\n \"totalAmount\": \"\",\n \"receivedNetAmount\": \"\",\n \"lastReceived\": \"\",\n \"categoryCode\": \"\",\n \"accountingParameters\": [\n {\n \"parameterCode\": \"\",\n \"parameterType\": \"\",\n \"parameterValueCode\": \"\"\n },\n {\n \"parameterCode\": \"\",\n \"parameterType\": \"\",\n \"parameterValueCode\": \"\"\n }\n ]\n },\n {\n \"purchaseOrderLineNumber\": \"\",\n \"quantityInvoiced\": \"\",\n \"quantityOrdered\": \"\",\n \"quantityReceived\": \"\",\n \"quantityRemaining\": \"\",\n \"status\": \"\",\n \"supplierItemNumber\": \"\",\n \"customerItemNumber\": \"\",\n \"description\": \"\",\n \"unitPrice\": \"\",\n \"unit\": \"\",\n \"vatPercentage\": \"\",\n \"netAmount\": \"\",\n \"discountPercentage\": \"\",\n \"discountAmount\": \"\",\n \"totalAmount\": \"\",\n \"receivedNetAmount\": \"\",\n \"lastReceived\": \"\",\n \"categoryCode\": \"\",\n \"accountingParameters\": [\n {\n \"parameterCode\": \"\",\n \"parameterType\": \"\",\n \"parameterValueCode\": \"\"\n },\n {\n \"parameterCode\": \"\",\n \"parameterType\": \"\",\n \"parameterValueCode\": \"\"\n }\n ]\n }\n ],\n \"categoryCode\": \"\"\n}" }, "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/purchaseOrders", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "purchaseOrders" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "If user doesn't have permission to access this resource.", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"currency\": \"\",\n \"erpVendorId\": \"\",\n \"purchaseOrderNumber\": \"\",\n \"status\": \"\",\n \"orderDate\": \"\",\n \"purchaser\": \"\",\n \"purchaseOrderLines\": [\n {\n \"purchaseOrderLineNumber\": \"\",\n \"quantityInvoiced\": \"\",\n \"quantityOrdered\": \"\",\n \"quantityReceived\": \"\",\n \"quantityRemaining\": \"\",\n \"status\": \"\",\n \"supplierItemNumber\": \"\",\n \"customerItemNumber\": \"\",\n \"description\": \"\",\n \"unitPrice\": \"\",\n \"unit\": \"\",\n \"vatPercentage\": \"\",\n \"netAmount\": \"\",\n \"discountPercentage\": \"\",\n \"discountAmount\": \"\",\n \"totalAmount\": \"\",\n \"receivedNetAmount\": \"\",\n \"lastReceived\": \"\",\n \"categoryCode\": \"\",\n \"accountingParameters\": [\n {\n \"parameterCode\": \"\",\n \"parameterType\": \"\",\n \"parameterValueCode\": \"\"\n },\n {\n \"parameterCode\": \"\",\n \"parameterType\": \"\",\n \"parameterValueCode\": \"\"\n }\n ]\n },\n {\n \"purchaseOrderLineNumber\": \"\",\n \"quantityInvoiced\": \"\",\n \"quantityOrdered\": \"\",\n \"quantityReceived\": \"\",\n \"quantityRemaining\": \"\",\n \"status\": \"\",\n \"supplierItemNumber\": \"\",\n \"customerItemNumber\": \"\",\n \"description\": \"\",\n \"unitPrice\": \"\",\n \"unit\": \"\",\n \"vatPercentage\": \"\",\n \"netAmount\": \"\",\n \"discountPercentage\": \"\",\n \"discountAmount\": \"\",\n \"totalAmount\": \"\",\n \"receivedNetAmount\": \"\",\n \"lastReceived\": \"\",\n \"categoryCode\": \"\",\n \"accountingParameters\": [\n {\n \"parameterCode\": \"\",\n \"parameterType\": \"\",\n \"parameterValueCode\": \"\"\n },\n {\n \"parameterCode\": \"\",\n \"parameterType\": \"\",\n \"parameterValueCode\": \"\"\n }\n ]\n }\n ],\n \"categoryCode\": \"\"\n}" }, "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/purchaseOrders", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "purchaseOrders" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "If any network or client related error occurs.", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"currency\": \"\",\n \"erpVendorId\": \"\",\n \"purchaseOrderNumber\": \"\",\n \"status\": \"\",\n \"orderDate\": \"\",\n \"purchaser\": \"\",\n \"purchaseOrderLines\": [\n {\n \"purchaseOrderLineNumber\": \"\",\n \"quantityInvoiced\": \"\",\n \"quantityOrdered\": \"\",\n \"quantityReceived\": \"\",\n \"quantityRemaining\": \"\",\n \"status\": \"\",\n \"supplierItemNumber\": \"\",\n \"customerItemNumber\": \"\",\n \"description\": \"\",\n \"unitPrice\": \"\",\n \"unit\": \"\",\n \"vatPercentage\": \"\",\n \"netAmount\": \"\",\n \"discountPercentage\": \"\",\n \"discountAmount\": \"\",\n \"totalAmount\": \"\",\n \"receivedNetAmount\": \"\",\n \"lastReceived\": \"\",\n \"categoryCode\": \"\",\n \"accountingParameters\": [\n {\n \"parameterCode\": \"\",\n \"parameterType\": \"\",\n \"parameterValueCode\": \"\"\n },\n {\n \"parameterCode\": \"\",\n \"parameterType\": \"\",\n \"parameterValueCode\": \"\"\n }\n ]\n },\n {\n \"purchaseOrderLineNumber\": \"\",\n \"quantityInvoiced\": \"\",\n \"quantityOrdered\": \"\",\n \"quantityReceived\": \"\",\n \"quantityRemaining\": \"\",\n \"status\": \"\",\n \"supplierItemNumber\": \"\",\n \"customerItemNumber\": \"\",\n \"description\": \"\",\n \"unitPrice\": \"\",\n \"unit\": \"\",\n \"vatPercentage\": \"\",\n \"netAmount\": \"\",\n \"discountPercentage\": \"\",\n \"discountAmount\": \"\",\n \"totalAmount\": \"\",\n \"receivedNetAmount\": \"\",\n \"lastReceived\": \"\",\n \"categoryCode\": \"\",\n \"accountingParameters\": [\n {\n \"parameterCode\": \"\",\n \"parameterType\": \"\",\n \"parameterValueCode\": \"\"\n },\n {\n \"parameterCode\": \"\",\n \"parameterType\": \"\",\n \"parameterValueCode\": \"\"\n }\n ]\n }\n ],\n \"categoryCode\": \"\"\n}" }, "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/purchaseOrders", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "purchaseOrders" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\"\n}" }, { "name": "Success", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"currency\": \"\",\n \"erpVendorId\": \"\",\n \"purchaseOrderNumber\": \"\",\n \"status\": \"\",\n \"orderDate\": \"\",\n \"purchaser\": \"\",\n \"purchaseOrderLines\": [\n {\n \"purchaseOrderLineNumber\": \"\",\n \"quantityInvoiced\": \"\",\n \"quantityOrdered\": \"\",\n \"quantityReceived\": \"\",\n \"quantityRemaining\": \"\",\n \"status\": \"\",\n \"supplierItemNumber\": \"\",\n \"customerItemNumber\": \"\",\n \"description\": \"\",\n \"unitPrice\": \"\",\n \"unit\": \"\",\n \"vatPercentage\": \"\",\n \"netAmount\": \"\",\n \"discountPercentage\": \"\",\n \"discountAmount\": \"\",\n \"totalAmount\": \"\",\n \"receivedNetAmount\": \"\",\n \"lastReceived\": \"\",\n \"categoryCode\": \"\",\n \"accountingParameters\": [\n {\n \"parameterCode\": \"\",\n \"parameterType\": \"\",\n \"parameterValueCode\": \"\"\n },\n {\n \"parameterCode\": \"\",\n \"parameterType\": \"\",\n \"parameterValueCode\": \"\"\n }\n ]\n },\n {\n \"purchaseOrderLineNumber\": \"\",\n \"quantityInvoiced\": \"\",\n \"quantityOrdered\": \"\",\n \"quantityReceived\": \"\",\n \"quantityRemaining\": \"\",\n \"status\": \"\",\n \"supplierItemNumber\": \"\",\n \"customerItemNumber\": \"\",\n \"description\": \"\",\n \"unitPrice\": \"\",\n \"unit\": \"\",\n \"vatPercentage\": \"\",\n \"netAmount\": \"\",\n \"discountPercentage\": \"\",\n \"discountAmount\": \"\",\n \"totalAmount\": \"\",\n \"receivedNetAmount\": \"\",\n \"lastReceived\": \"\",\n \"categoryCode\": \"\",\n \"accountingParameters\": [\n {\n \"parameterCode\": \"\",\n \"parameterType\": \"\",\n \"parameterValueCode\": \"\"\n },\n {\n \"parameterCode\": \"\",\n \"parameterType\": \"\",\n \"parameterValueCode\": \"\"\n }\n ]\n }\n ],\n \"categoryCode\": \"\"\n}" }, "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/purchaseOrders", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "purchaseOrders" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "If any validation fails for both purchase order metadata and purchase order lines.", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"currency\": \"\",\n \"erpVendorId\": \"\",\n \"purchaseOrderNumber\": \"\",\n \"status\": \"\",\n \"orderDate\": \"\",\n \"purchaser\": \"\",\n \"purchaseOrderLines\": [\n {\n \"purchaseOrderLineNumber\": \"\",\n \"quantityInvoiced\": \"\",\n \"quantityOrdered\": \"\",\n \"quantityReceived\": \"\",\n \"quantityRemaining\": \"\",\n \"status\": \"\",\n \"supplierItemNumber\": \"\",\n \"customerItemNumber\": \"\",\n \"description\": \"\",\n \"unitPrice\": \"\",\n \"unit\": \"\",\n \"vatPercentage\": \"\",\n \"netAmount\": \"\",\n \"discountPercentage\": \"\",\n \"discountAmount\": \"\",\n \"totalAmount\": \"\",\n \"receivedNetAmount\": \"\",\n \"lastReceived\": \"\",\n \"categoryCode\": \"\",\n \"accountingParameters\": [\n {\n \"parameterCode\": \"\",\n \"parameterType\": \"\",\n \"parameterValueCode\": \"\"\n },\n {\n \"parameterCode\": \"\",\n \"parameterType\": \"\",\n \"parameterValueCode\": \"\"\n }\n ]\n },\n {\n \"purchaseOrderLineNumber\": \"\",\n \"quantityInvoiced\": \"\",\n \"quantityOrdered\": \"\",\n \"quantityReceived\": \"\",\n \"quantityRemaining\": \"\",\n \"status\": \"\",\n \"supplierItemNumber\": \"\",\n \"customerItemNumber\": \"\",\n \"description\": \"\",\n \"unitPrice\": \"\",\n \"unit\": \"\",\n \"vatPercentage\": \"\",\n \"netAmount\": \"\",\n \"discountPercentage\": \"\",\n \"discountAmount\": \"\",\n \"totalAmount\": \"\",\n \"receivedNetAmount\": \"\",\n \"lastReceived\": \"\",\n \"categoryCode\": \"\",\n \"accountingParameters\": [\n {\n \"parameterCode\": \"\",\n \"parameterType\": \"\",\n \"parameterValueCode\": \"\"\n },\n {\n \"parameterCode\": \"\",\n \"parameterType\": \"\",\n \"parameterValueCode\": \"\"\n }\n ]\n }\n ],\n \"categoryCode\": \"\"\n}" }, "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/purchaseOrders", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "purchaseOrders" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] }, { "name": "/purchaseOrders/:purchaseOrderNumber", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/purchaseOrders/:purchaseOrderNumber", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "purchaseOrders", ":purchaseOrderNumber" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization id of which this purchase order is related to." }, { "key": "clientId", "value": "", "description": "(Required) Client id of which this purchase order is related to." }, { "key": "purchaseOrderNumber", "value": "", "description": "(Required) PurchaseOrderNumber of object to be deleted." } ] }, "description": "Deletes the given purchase order object and related purchase order line items." }, "response": [ { "name": "If any network or client related error occurs.", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/purchaseOrders/:purchaseOrderNumber", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "purchaseOrders", ":purchaseOrderNumber" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" }, { "key": "purchaseOrderNumber" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\"\n}" }, { "name": "If user doesn't have permission to access this resource.", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/purchaseOrders/:purchaseOrderNumber", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "purchaseOrders", ":purchaseOrderNumber" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" }, { "key": "purchaseOrderNumber" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "With a message \"delete message sent!\".", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/purchaseOrders/:purchaseOrderNumber", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "purchaseOrders", ":purchaseOrderNumber" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" }, { "key": "purchaseOrderNumber" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "\"\"" }, { "name": "If security token is not provided or user not authenticated.", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/purchaseOrders/:purchaseOrderNumber", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "purchaseOrders", ":purchaseOrderNumber" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" }, { "key": "purchaseOrderNumber" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "If any validation fails for both purchase order metadata and purchase order lines.", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/purchaseOrders/:purchaseOrderNumber", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "purchaseOrders", ":purchaseOrderNumber" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" }, { "key": "purchaseOrderNumber" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] } ] }, { "name": "suppliers", "item": [ { "name": "{code}", "item": [ { "name": "/suppliers/:code", "request": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/suppliers/1234", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "suppliers", "1234" ] }, "description": "Gets a supplier for a given client" }, "response": [ { "name": "If any network or client related error occurs.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/suppliers/:code", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "suppliers", ":code" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" }, { "key": "code" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\"\n}" }, { "name": "The supplier with the given code", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/suppliers/:code", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "suppliers", ":code" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" }, { "key": "code" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"address\": {\n \"country\": \"\",\n \"street\": \"\",\n \"city\": \"\",\n \"zipcode\": \"\",\n \"phone\": \"\",\n \"email\": \"\"\n },\n \"code\": \"\",\n \"name\": \"\",\n \"organizationNumber\": \"\",\n \"status\": \"\",\n \"organizationAuthorityCode\": \"\",\n \"bankAccounts\": [\n {\n \"accountNumber\": \"\",\n \"bankName\": \"\",\n \"status\": \"\",\n \"ibanAccountNumber\": \"\",\n \"swiftCode\": \"\"\n },\n {\n \"accountNumber\": \"\",\n \"bankName\": \"\",\n \"status\": \"\",\n \"ibanAccountNumber\": \"\",\n \"swiftCode\": \"\"\n }\n ],\n \"defaultAccountingCode\": \"\"\n}" }, { "name": "If the request is malformed.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/suppliers/:code", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "suppliers", ":code" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" }, { "key": "code" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "If security token is not provided or user not authenticated.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/suppliers/:code", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "suppliers", ":code" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" }, { "key": "code" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "If user doesn't have permission to access this resource.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/suppliers/:code", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "suppliers", ":code" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" }, { "key": "code" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/suppliers/:code", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "suppliers", ":code" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" }, { "key": "code" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] }, { "name": "/suppliers/:code", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/suppliers/:code", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "suppliers", ":code" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization Id of which this supplier is related to." }, { "key": "clientId", "value": "", "description": "(Required) Client Id of which this supplier is related to." }, { "key": "code", "value": "", "description": "(Required) The unique code of the supplier to be deleted" } ] }, "description": "Soft-deletes the referenced supplier" }, "response": [ { "name": "Returns the deleted supplier", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/suppliers/:code", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "suppliers", ":code" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" }, { "key": "code" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"address\": {\n \"country\": \"\",\n \"street\": \"\",\n \"city\": \"\",\n \"zipcode\": \"\",\n \"phone\": \"\",\n \"email\": \"\"\n },\n \"code\": \"\",\n \"name\": \"\",\n \"organizationNumber\": \"\",\n \"status\": \"\",\n \"organizationAuthorityCode\": \"\",\n \"bankAccounts\": [\n {\n \"accountNumber\": \"\",\n \"bankName\": \"\",\n \"status\": \"\",\n \"ibanAccountNumber\": \"\",\n \"swiftCode\": \"\"\n },\n {\n \"accountNumber\": \"\",\n \"bankName\": \"\",\n \"status\": \"\",\n \"ibanAccountNumber\": \"\",\n \"swiftCode\": \"\"\n }\n ],\n \"defaultAccountingCode\": \"\"\n}" }, { "name": "If user doesn't have permission to access this resource.", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/suppliers/:code", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "suppliers", ":code" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" }, { "key": "code" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "If any network or client related error occurs.", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/suppliers/:code", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "suppliers", ":code" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" }, { "key": "code" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\"\n}" }, { "name": "If security token is not provided or user not authenticated.", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/suppliers/:code", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "suppliers", ":code" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" }, { "key": "code" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "If the request is malformed", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/suppliers/:code", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "suppliers", ":code" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" }, { "key": "code" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] } ] }, { "name": "/suppliers", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "[\n {\n \"address\": {\n \"country\": \"\",\n \"street\": \"\",\n \"city\": \"\",\n \"zipcode\": \"\",\n \"phone\": \"\",\n \"email\": \"\"\n },\n \"code\": \"\",\n \"name\": \"\",\n \"organizationNumber\": \"\",\n \"status\": \"\",\n \"organizationAuthorityCode\": \"\",\n \"bankAccounts\": [\n {\n \"accountNumber\": \"\",\n \"bankName\": \"\",\n \"status\": \"\",\n \"ibanAccountNumber\": \"\",\n \"swiftCode\": \"\"\n },\n {\n \"accountNumber\": \"\",\n \"bankName\": \"\",\n \"status\": \"\",\n \"ibanAccountNumber\": \"\",\n \"swiftCode\": \"\"\n }\n ],\n \"defaultAccountingCode\": \"\"\n },\n {\n \"address\": {\n \"country\": \"\",\n \"street\": \"\",\n \"city\": \"\",\n \"zipcode\": \"\",\n \"phone\": \"\",\n \"email\": \"\"\n },\n \"code\": \"\",\n \"name\": \"\",\n \"organizationNumber\": \"\",\n \"status\": \"\",\n \"organizationAuthorityCode\": \"\",\n \"bankAccounts\": [\n {\n \"accountNumber\": \"\",\n \"bankName\": \"\",\n \"status\": \"\",\n \"ibanAccountNumber\": \"\",\n \"swiftCode\": \"\"\n },\n {\n \"accountNumber\": \"\",\n \"bankName\": \"\",\n \"status\": \"\",\n \"ibanAccountNumber\": \"\",\n \"swiftCode\": \"\"\n }\n ],\n \"defaultAccountingCode\": \"\"\n }\n]" }, "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/suppliers", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "suppliers" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization id of which this suppliers are related to." }, { "key": "clientId", "value": "", "description": "(Required) Client id of which this suppliers are related to." } ] }, "description": "Inserts and updates a set of suppliers for a client" }, "response": [ { "name": "The result of the operation for each supplier", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "[\n {\n \"address\": {\n \"country\": \"\",\n \"street\": \"\",\n \"city\": \"\",\n \"zipcode\": \"\",\n \"phone\": \"\",\n \"email\": \"\"\n },\n \"code\": \"\",\n \"name\": \"\",\n \"organizationNumber\": \"\",\n \"status\": \"\",\n \"organizationAuthorityCode\": \"\",\n \"bankAccounts\": [\n {\n \"accountNumber\": \"\",\n \"bankName\": \"\",\n \"status\": \"\",\n \"ibanAccountNumber\": \"\",\n \"swiftCode\": \"\"\n },\n {\n \"accountNumber\": \"\",\n \"bankName\": \"\",\n \"status\": \"\",\n \"ibanAccountNumber\": \"\",\n \"swiftCode\": \"\"\n }\n ],\n \"defaultAccountingCode\": \"\"\n },\n {\n \"address\": {\n \"country\": \"\",\n \"street\": \"\",\n \"city\": \"\",\n \"zipcode\": \"\",\n \"phone\": \"\",\n \"email\": \"\"\n },\n \"code\": \"\",\n \"name\": \"\",\n \"organizationNumber\": \"\",\n \"status\": \"\",\n \"organizationAuthorityCode\": \"\",\n \"bankAccounts\": [\n {\n \"accountNumber\": \"\",\n \"bankName\": \"\",\n \"status\": \"\",\n \"ibanAccountNumber\": \"\",\n \"swiftCode\": \"\"\n },\n {\n \"accountNumber\": \"\",\n \"bankName\": \"\",\n \"status\": \"\",\n \"ibanAccountNumber\": \"\",\n \"swiftCode\": \"\"\n }\n ],\n \"defaultAccountingCode\": \"\"\n }\n]" }, "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/suppliers", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "suppliers" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"failed\": [\n {\n \"item\": {\n \"address\": {\n \"country\": \"\",\n \"street\": \"\",\n \"city\": \"\",\n \"zipcode\": \"\",\n \"phone\": \"\",\n \"email\": \"\"\n },\n \"code\": \"\",\n \"name\": \"\",\n \"organizationNumber\": \"\",\n \"status\": \"\",\n \"organizationAuthorityCode\": \"\",\n \"bankAccounts\": [\n {\n \"accountNumber\": \"\",\n \"bankName\": \"\",\n \"status\": \"\",\n \"ibanAccountNumber\": \"\",\n \"swiftCode\": \"\"\n },\n {\n \"accountNumber\": \"\",\n \"bankName\": \"\",\n \"status\": \"\",\n \"ibanAccountNumber\": \"\",\n \"swiftCode\": \"\"\n }\n ],\n \"defaultAccountingCode\": \"\"\n },\n \"message\": \"\"\n },\n {\n \"item\": {\n \"address\": {\n \"country\": \"\",\n \"street\": \"\",\n \"city\": \"\",\n \"zipcode\": \"\",\n \"phone\": \"\",\n \"email\": \"\"\n },\n \"code\": \"\",\n \"name\": \"\",\n \"organizationNumber\": \"\",\n \"status\": \"\",\n \"organizationAuthorityCode\": \"\",\n \"bankAccounts\": [\n {\n \"accountNumber\": \"\",\n \"bankName\": \"\",\n \"status\": \"\",\n \"ibanAccountNumber\": \"\",\n \"swiftCode\": \"\"\n },\n {\n \"accountNumber\": \"\",\n \"bankName\": \"\",\n \"status\": \"\",\n \"ibanAccountNumber\": \"\",\n \"swiftCode\": \"\"\n }\n ],\n \"defaultAccountingCode\": \"\"\n },\n \"message\": \"\"\n }\n ]\n}" }, { "name": "If security token is not provided or user not authenticated.", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "[\n {\n \"address\": {\n \"country\": \"\",\n \"street\": \"\",\n \"city\": \"\",\n \"zipcode\": \"\",\n \"phone\": \"\",\n \"email\": \"\"\n },\n \"code\": \"\",\n \"name\": \"\",\n \"organizationNumber\": \"\",\n \"status\": \"\",\n \"organizationAuthorityCode\": \"\",\n \"bankAccounts\": [\n {\n \"accountNumber\": \"\",\n \"bankName\": \"\",\n \"status\": \"\",\n \"ibanAccountNumber\": \"\",\n \"swiftCode\": \"\"\n },\n {\n \"accountNumber\": \"\",\n \"bankName\": \"\",\n \"status\": \"\",\n \"ibanAccountNumber\": \"\",\n \"swiftCode\": \"\"\n }\n ],\n \"defaultAccountingCode\": \"\"\n },\n {\n \"address\": {\n \"country\": \"\",\n \"street\": \"\",\n \"city\": \"\",\n \"zipcode\": \"\",\n \"phone\": \"\",\n \"email\": \"\"\n },\n \"code\": \"\",\n \"name\": \"\",\n \"organizationNumber\": \"\",\n \"status\": \"\",\n \"organizationAuthorityCode\": \"\",\n \"bankAccounts\": [\n {\n \"accountNumber\": \"\",\n \"bankName\": \"\",\n \"status\": \"\",\n \"ibanAccountNumber\": \"\",\n \"swiftCode\": \"\"\n },\n {\n \"accountNumber\": \"\",\n \"bankName\": \"\",\n \"status\": \"\",\n \"ibanAccountNumber\": \"\",\n \"swiftCode\": \"\"\n }\n ],\n \"defaultAccountingCode\": \"\"\n }\n]" }, "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/suppliers", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "suppliers" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "If the request is malformed", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "[\n {\n \"address\": {\n \"country\": \"\",\n \"street\": \"\",\n \"city\": \"\",\n \"zipcode\": \"\",\n \"phone\": \"\",\n \"email\": \"\"\n },\n \"code\": \"\",\n \"name\": \"\",\n \"organizationNumber\": \"\",\n \"status\": \"\",\n \"organizationAuthorityCode\": \"\",\n \"bankAccounts\": [\n {\n \"accountNumber\": \"\",\n \"bankName\": \"\",\n \"status\": \"\",\n \"ibanAccountNumber\": \"\",\n \"swiftCode\": \"\"\n },\n {\n \"accountNumber\": \"\",\n \"bankName\": \"\",\n \"status\": \"\",\n \"ibanAccountNumber\": \"\",\n \"swiftCode\": \"\"\n }\n ],\n \"defaultAccountingCode\": \"\"\n },\n {\n \"address\": {\n \"country\": \"\",\n \"street\": \"\",\n \"city\": \"\",\n \"zipcode\": \"\",\n \"phone\": \"\",\n \"email\": \"\"\n },\n \"code\": \"\",\n \"name\": \"\",\n \"organizationNumber\": \"\",\n \"status\": \"\",\n \"organizationAuthorityCode\": \"\",\n \"bankAccounts\": [\n {\n \"accountNumber\": \"\",\n \"bankName\": \"\",\n \"status\": \"\",\n \"ibanAccountNumber\": \"\",\n \"swiftCode\": \"\"\n },\n {\n \"accountNumber\": \"\",\n \"bankName\": \"\",\n \"status\": \"\",\n \"ibanAccountNumber\": \"\",\n \"swiftCode\": \"\"\n }\n ],\n \"defaultAccountingCode\": \"\"\n }\n]" }, "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/suppliers", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "suppliers" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "If any network or client related error occurs.", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "[\n {\n \"address\": {\n \"country\": \"\",\n \"street\": \"\",\n \"city\": \"\",\n \"zipcode\": \"\",\n \"phone\": \"\",\n \"email\": \"\"\n },\n \"code\": \"\",\n \"name\": \"\",\n \"organizationNumber\": \"\",\n \"status\": \"\",\n \"organizationAuthorityCode\": \"\",\n \"bankAccounts\": [\n {\n \"accountNumber\": \"\",\n \"bankName\": \"\",\n \"status\": \"\",\n \"ibanAccountNumber\": \"\",\n \"swiftCode\": \"\"\n },\n {\n \"accountNumber\": \"\",\n \"bankName\": \"\",\n \"status\": \"\",\n \"ibanAccountNumber\": \"\",\n \"swiftCode\": \"\"\n }\n ],\n \"defaultAccountingCode\": \"\"\n },\n {\n \"address\": {\n \"country\": \"\",\n \"street\": \"\",\n \"city\": \"\",\n \"zipcode\": \"\",\n \"phone\": \"\",\n \"email\": \"\"\n },\n \"code\": \"\",\n \"name\": \"\",\n \"organizationNumber\": \"\",\n \"status\": \"\",\n \"organizationAuthorityCode\": \"\",\n \"bankAccounts\": [\n {\n \"accountNumber\": \"\",\n \"bankName\": \"\",\n \"status\": \"\",\n \"ibanAccountNumber\": \"\",\n \"swiftCode\": \"\"\n },\n {\n \"accountNumber\": \"\",\n \"bankName\": \"\",\n \"status\": \"\",\n \"ibanAccountNumber\": \"\",\n \"swiftCode\": \"\"\n }\n ],\n \"defaultAccountingCode\": \"\"\n }\n]" }, "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/suppliers", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "suppliers" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\"\n}" }, { "name": "If user doesn't have permission to access this resource.", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "[\n {\n \"address\": {\n \"country\": \"\",\n \"street\": \"\",\n \"city\": \"\",\n \"zipcode\": \"\",\n \"phone\": \"\",\n \"email\": \"\"\n },\n \"code\": \"\",\n \"name\": \"\",\n \"organizationNumber\": \"\",\n \"status\": \"\",\n \"organizationAuthorityCode\": \"\",\n \"bankAccounts\": [\n {\n \"accountNumber\": \"\",\n \"bankName\": \"\",\n \"status\": \"\",\n \"ibanAccountNumber\": \"\",\n \"swiftCode\": \"\"\n },\n {\n \"accountNumber\": \"\",\n \"bankName\": \"\",\n \"status\": \"\",\n \"ibanAccountNumber\": \"\",\n \"swiftCode\": \"\"\n }\n ],\n \"defaultAccountingCode\": \"\"\n },\n {\n \"address\": {\n \"country\": \"\",\n \"street\": \"\",\n \"city\": \"\",\n \"zipcode\": \"\",\n \"phone\": \"\",\n \"email\": \"\"\n },\n \"code\": \"\",\n \"name\": \"\",\n \"organizationNumber\": \"\",\n \"status\": \"\",\n \"organizationAuthorityCode\": \"\",\n \"bankAccounts\": [\n {\n \"accountNumber\": \"\",\n \"bankName\": \"\",\n \"status\": \"\",\n \"ibanAccountNumber\": \"\",\n \"swiftCode\": \"\"\n },\n {\n \"accountNumber\": \"\",\n \"bankName\": \"\",\n \"status\": \"\",\n \"ibanAccountNumber\": \"\",\n \"swiftCode\": \"\"\n }\n ],\n \"defaultAccountingCode\": \"\"\n }\n]" }, "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/suppliers", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "suppliers" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] }, { "name": "/suppliers Minimum", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "[\n {\n \"address\": {\n \"country\": \"NO\"\n },\n \"code\": \"1234\",\n \"name\": \"Supplier Name\",\n \"organizationNumber\": \"123456789\",\n \"status\": \"Active\",\n \"bankAccounts\": [\n {\n \"accountNumber\": \"12345678901\",\n \"bankName\": \"Bank Name\",\n \"status\": \"Inactive\"\n }\n ]\n }\n]" }, "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/suppliers", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "suppliers" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization id of which this suppliers are related to." }, { "key": "clientId", "value": "", "description": "(Required) Client id of which this suppliers are related to." } ] }, "description": "Inserts and updates a set of suppliers for a client" }, "response": [ { "name": "The result of the operation for each supplier", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "[\n {\n \"address\": {\n \"country\": \"\",\n \"street\": \"\",\n \"city\": \"\",\n \"zipcode\": \"\",\n \"phone\": \"\",\n \"email\": \"\"\n },\n \"code\": \"\",\n \"name\": \"\",\n \"organizationNumber\": \"\",\n \"status\": \"\",\n \"organizationAuthorityCode\": \"\",\n \"bankAccounts\": [\n {\n \"accountNumber\": \"\",\n \"bankName\": \"\",\n \"status\": \"\",\n \"ibanAccountNumber\": \"\",\n \"swiftCode\": \"\"\n },\n {\n \"accountNumber\": \"\",\n \"bankName\": \"\",\n \"status\": \"\",\n \"ibanAccountNumber\": \"\",\n \"swiftCode\": \"\"\n }\n ],\n \"defaultAccountingCode\": \"\"\n },\n {\n \"address\": {\n \"country\": \"\",\n \"street\": \"\",\n \"city\": \"\",\n \"zipcode\": \"\",\n \"phone\": \"\",\n \"email\": \"\"\n },\n \"code\": \"\",\n \"name\": \"\",\n \"organizationNumber\": \"\",\n \"status\": \"\",\n \"organizationAuthorityCode\": \"\",\n \"bankAccounts\": [\n {\n \"accountNumber\": \"\",\n \"bankName\": \"\",\n \"status\": \"\",\n \"ibanAccountNumber\": \"\",\n \"swiftCode\": \"\"\n },\n {\n \"accountNumber\": \"\",\n \"bankName\": \"\",\n \"status\": \"\",\n \"ibanAccountNumber\": \"\",\n \"swiftCode\": \"\"\n }\n ],\n \"defaultAccountingCode\": \"\"\n }\n]" }, "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/suppliers", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "suppliers" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"failed\": [\n {\n \"item\": {\n \"address\": {\n \"country\": \"\",\n \"street\": \"\",\n \"city\": \"\",\n \"zipcode\": \"\",\n \"phone\": \"\",\n \"email\": \"\"\n },\n \"code\": \"\",\n \"name\": \"\",\n \"organizationNumber\": \"\",\n \"status\": \"\",\n \"organizationAuthorityCode\": \"\",\n \"bankAccounts\": [\n {\n \"accountNumber\": \"\",\n \"bankName\": \"\",\n \"status\": \"\",\n \"ibanAccountNumber\": \"\",\n \"swiftCode\": \"\"\n },\n {\n \"accountNumber\": \"\",\n \"bankName\": \"\",\n \"status\": \"\",\n \"ibanAccountNumber\": \"\",\n \"swiftCode\": \"\"\n }\n ],\n \"defaultAccountingCode\": \"\"\n },\n \"message\": \"\"\n },\n {\n \"item\": {\n \"address\": {\n \"country\": \"\",\n \"street\": \"\",\n \"city\": \"\",\n \"zipcode\": \"\",\n \"phone\": \"\",\n \"email\": \"\"\n },\n \"code\": \"\",\n \"name\": \"\",\n \"organizationNumber\": \"\",\n \"status\": \"\",\n \"organizationAuthorityCode\": \"\",\n \"bankAccounts\": [\n {\n \"accountNumber\": \"\",\n \"bankName\": \"\",\n \"status\": \"\",\n \"ibanAccountNumber\": \"\",\n \"swiftCode\": \"\"\n },\n {\n \"accountNumber\": \"\",\n \"bankName\": \"\",\n \"status\": \"\",\n \"ibanAccountNumber\": \"\",\n \"swiftCode\": \"\"\n }\n ],\n \"defaultAccountingCode\": \"\"\n },\n \"message\": \"\"\n }\n ]\n}" }, { "name": "If the request is malformed", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "[\n {\n \"address\": {\n \"country\": \"\",\n \"street\": \"\",\n \"city\": \"\",\n \"zipcode\": \"\",\n \"phone\": \"\",\n \"email\": \"\"\n },\n \"code\": \"\",\n \"name\": \"\",\n \"organizationNumber\": \"\",\n \"status\": \"\",\n \"organizationAuthorityCode\": \"\",\n \"bankAccounts\": [\n {\n \"accountNumber\": \"\",\n \"bankName\": \"\",\n \"status\": \"\",\n \"ibanAccountNumber\": \"\",\n \"swiftCode\": \"\"\n },\n {\n \"accountNumber\": \"\",\n \"bankName\": \"\",\n \"status\": \"\",\n \"ibanAccountNumber\": \"\",\n \"swiftCode\": \"\"\n }\n ],\n \"defaultAccountingCode\": \"\"\n },\n {\n \"address\": {\n \"country\": \"\",\n \"street\": \"\",\n \"city\": \"\",\n \"zipcode\": \"\",\n \"phone\": \"\",\n \"email\": \"\"\n },\n \"code\": \"\",\n \"name\": \"\",\n \"organizationNumber\": \"\",\n \"status\": \"\",\n \"organizationAuthorityCode\": \"\",\n \"bankAccounts\": [\n {\n \"accountNumber\": \"\",\n \"bankName\": \"\",\n \"status\": \"\",\n \"ibanAccountNumber\": \"\",\n \"swiftCode\": \"\"\n },\n {\n \"accountNumber\": \"\",\n \"bankName\": \"\",\n \"status\": \"\",\n \"ibanAccountNumber\": \"\",\n \"swiftCode\": \"\"\n }\n ],\n \"defaultAccountingCode\": \"\"\n }\n]" }, "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/suppliers", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "suppliers" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "If any network or client related error occurs.", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "[\n {\n \"address\": {\n \"country\": \"\",\n \"street\": \"\",\n \"city\": \"\",\n \"zipcode\": \"\",\n \"phone\": \"\",\n \"email\": \"\"\n },\n \"code\": \"\",\n \"name\": \"\",\n \"organizationNumber\": \"\",\n \"status\": \"\",\n \"organizationAuthorityCode\": \"\",\n \"bankAccounts\": [\n {\n \"accountNumber\": \"\",\n \"bankName\": \"\",\n \"status\": \"\",\n \"ibanAccountNumber\": \"\",\n \"swiftCode\": \"\"\n },\n {\n \"accountNumber\": \"\",\n \"bankName\": \"\",\n \"status\": \"\",\n \"ibanAccountNumber\": \"\",\n \"swiftCode\": \"\"\n }\n ],\n \"defaultAccountingCode\": \"\"\n },\n {\n \"address\": {\n \"country\": \"\",\n \"street\": \"\",\n \"city\": \"\",\n \"zipcode\": \"\",\n \"phone\": \"\",\n \"email\": \"\"\n },\n \"code\": \"\",\n \"name\": \"\",\n \"organizationNumber\": \"\",\n \"status\": \"\",\n \"organizationAuthorityCode\": \"\",\n \"bankAccounts\": [\n {\n \"accountNumber\": \"\",\n \"bankName\": \"\",\n \"status\": \"\",\n \"ibanAccountNumber\": \"\",\n \"swiftCode\": \"\"\n },\n {\n \"accountNumber\": \"\",\n \"bankName\": \"\",\n \"status\": \"\",\n \"ibanAccountNumber\": \"\",\n \"swiftCode\": \"\"\n }\n ],\n \"defaultAccountingCode\": \"\"\n }\n]" }, "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/suppliers", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "suppliers" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\"\n}" }, { "name": "If security token is not provided or user not authenticated.", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "[\n {\n \"address\": {\n \"country\": \"\",\n \"street\": \"\",\n \"city\": \"\",\n \"zipcode\": \"\",\n \"phone\": \"\",\n \"email\": \"\"\n },\n \"code\": \"\",\n \"name\": \"\",\n \"organizationNumber\": \"\",\n \"status\": \"\",\n \"organizationAuthorityCode\": \"\",\n \"bankAccounts\": [\n {\n \"accountNumber\": \"\",\n \"bankName\": \"\",\n \"status\": \"\",\n \"ibanAccountNumber\": \"\",\n \"swiftCode\": \"\"\n },\n {\n \"accountNumber\": \"\",\n \"bankName\": \"\",\n \"status\": \"\",\n \"ibanAccountNumber\": \"\",\n \"swiftCode\": \"\"\n }\n ],\n \"defaultAccountingCode\": \"\"\n },\n {\n \"address\": {\n \"country\": \"\",\n \"street\": \"\",\n \"city\": \"\",\n \"zipcode\": \"\",\n \"phone\": \"\",\n \"email\": \"\"\n },\n \"code\": \"\",\n \"name\": \"\",\n \"organizationNumber\": \"\",\n \"status\": \"\",\n \"organizationAuthorityCode\": \"\",\n \"bankAccounts\": [\n {\n \"accountNumber\": \"\",\n \"bankName\": \"\",\n \"status\": \"\",\n \"ibanAccountNumber\": \"\",\n \"swiftCode\": \"\"\n },\n {\n \"accountNumber\": \"\",\n \"bankName\": \"\",\n \"status\": \"\",\n \"ibanAccountNumber\": \"\",\n \"swiftCode\": \"\"\n }\n ],\n \"defaultAccountingCode\": \"\"\n }\n]" }, "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/suppliers", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "suppliers" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "If user doesn't have permission to access this resource.", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "[\n {\n \"address\": {\n \"country\": \"\",\n \"street\": \"\",\n \"city\": \"\",\n \"zipcode\": \"\",\n \"phone\": \"\",\n \"email\": \"\"\n },\n \"code\": \"\",\n \"name\": \"\",\n \"organizationNumber\": \"\",\n \"status\": \"\",\n \"organizationAuthorityCode\": \"\",\n \"bankAccounts\": [\n {\n \"accountNumber\": \"\",\n \"bankName\": \"\",\n \"status\": \"\",\n \"ibanAccountNumber\": \"\",\n \"swiftCode\": \"\"\n },\n {\n \"accountNumber\": \"\",\n \"bankName\": \"\",\n \"status\": \"\",\n \"ibanAccountNumber\": \"\",\n \"swiftCode\": \"\"\n }\n ],\n \"defaultAccountingCode\": \"\"\n },\n {\n \"address\": {\n \"country\": \"\",\n \"street\": \"\",\n \"city\": \"\",\n \"zipcode\": \"\",\n \"phone\": \"\",\n \"email\": \"\"\n },\n \"code\": \"\",\n \"name\": \"\",\n \"organizationNumber\": \"\",\n \"status\": \"\",\n \"organizationAuthorityCode\": \"\",\n \"bankAccounts\": [\n {\n \"accountNumber\": \"\",\n \"bankName\": \"\",\n \"status\": \"\",\n \"ibanAccountNumber\": \"\",\n \"swiftCode\": \"\"\n },\n {\n \"accountNumber\": \"\",\n \"bankName\": \"\",\n \"status\": \"\",\n \"ibanAccountNumber\": \"\",\n \"swiftCode\": \"\"\n }\n ],\n \"defaultAccountingCode\": \"\"\n }\n]" }, "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/suppliers", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "suppliers" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] } ] }, { "name": "transactiontypes", "item": [ { "name": "{code}", "item": [ { "name": "/transactiontypes/:code", "request": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/transactiontypes/:code", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "transactiontypes", ":code" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization id of the organization to which the transaction type is related." }, { "key": "clientId", "value": "", "description": "(Required) Client id of the client to which the transaction type is related." }, { "key": "code", "value": "", "description": "(Required) The ERP code for the transaction type" } ] }, "description": "Gets a transaction type based on the ERP code." }, "response": [ { "name": "If user doesn't have permission to access this resource.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/transactiontypes/:code", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "transactiontypes", ":code" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" }, { "key": "code" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "If any network or client related error occurs.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/transactiontypes/:code", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "transactiontypes", ":code" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" }, { "key": "code" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\"\n}" }, { "name": "The transaction type for the given client with requested code", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/transactiontypes/:code", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "transactiontypes", ":code" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" }, { "key": "code" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"\",\n \"status\": \"\",\n \"description\": [\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n },\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n }\n ]\n}" }, { "name": "Transaction type does not exist.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/transactiontypes/:code", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "transactiontypes", ":code" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" }, { "key": "code" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "If security token is not provided or user not authenticated.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/transactiontypes/:code", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "transactiontypes", ":code" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" }, { "key": "code" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Validation of model fails.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/transactiontypes/:code", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "transactiontypes", ":code" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" }, { "key": "code" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] }, { "name": "/transactiontypes/:code", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/transactiontypes/:code", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "transactiontypes", ":code" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization id of the organization to which the transaction type is related." }, { "key": "clientId", "value": "", "description": "(Required) Client id of the client to which the transaction type is related." }, { "key": "code", "value": "", "description": "(Required) The ERP code of the transaction type to delete" } ] }, "description": "Delete a transaction type" }, "response": [ { "name": "If user doesn't have permission to access this resource.", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/transactiontypes/:code", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "transactiontypes", ":code" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" }, { "key": "code" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "The transaction type has been deleted successfully", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/transactiontypes/:code", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "transactiontypes", ":code" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" }, { "key": "code" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"\",\n \"status\": \"\",\n \"description\": [\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n },\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n }\n ]\n}" }, { "name": "If security token is not provided or user not authenticated.", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/transactiontypes/:code", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "transactiontypes", ":code" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" }, { "key": "code" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "If any network or client related error occurs.", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/transactiontypes/:code", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "transactiontypes", ":code" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" }, { "key": "code" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\"\n}" }, { "name": "Validation of model fails.", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/transactiontypes/:code", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "transactiontypes", ":code" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" }, { "key": "code" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] } ] }, { "name": "/transactiontypes", "request": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/transactiontypes?textSearch=", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "transactiontypes" ], "query": [ { "key": "textSearch", "value": "", "description": "Optional search for text in codes or descriptions" } ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization id of the organization to which the transaction types are related." }, { "key": "clientId", "value": "", "description": "(Required) Client id of the client to which the transaction types are related." } ] }, "description": "Gets all transaction types for a given client." }, "response": [ { "name": "If user doesn't have permission to access this resource.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/transactiontypes?textSearch=", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "transactiontypes" ], "query": [ { "key": "textSearch", "value": "" } ], "variable": [ { "key": "organizationId" }, { "key": "clientId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "If security token is not provided or user not authenticated.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/transactiontypes?textSearch=", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "transactiontypes" ], "query": [ { "key": "textSearch", "value": "" } ], "variable": [ { "key": "organizationId" }, { "key": "clientId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "The transaction types for the given client", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/transactiontypes?textSearch=", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "transactiontypes" ], "query": [ { "key": "textSearch", "value": "" } ], "variable": [ { "key": "organizationId" }, { "key": "clientId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"code\": \"\",\n \"status\": \"\",\n \"description\": [\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n },\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n }\n ]\n },\n {\n \"code\": \"\",\n \"status\": \"\",\n \"description\": [\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n },\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n }\n ]\n }\n]" }, { "name": "No transaction types exist for the given client", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/transactiontypes?textSearch=", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "transactiontypes" ], "query": [ { "key": "textSearch", "value": "" } ], "variable": [ { "key": "organizationId" }, { "key": "clientId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Validation of model fails.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/transactiontypes?textSearch=", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "transactiontypes" ], "query": [ { "key": "textSearch", "value": "" } ], "variable": [ { "key": "organizationId" }, { "key": "clientId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "If any network or client related error occurs.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/transactiontypes?textSearch=", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "transactiontypes" ], "query": [ { "key": "textSearch", "value": "" } ], "variable": [ { "key": "organizationId" }, { "key": "clientId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\"\n}" } ] }, { "name": "/transactiontypes", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "[\n {\n \"code\": \"\",\n \"status\": \"\",\n \"description\": [\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n },\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n }\n ]\n },\n {\n \"code\": \"\",\n \"status\": \"\",\n \"description\": [\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n },\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n }\n ]\n }\n]" }, "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/transactiontypes", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "transactiontypes" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization id of the organizations to which the transaction types are related." }, { "key": "clientId", "value": "", "description": "(Required) Client id of the client to which the transaction types are related." } ] }, "description": "Inserts and updates transaction types" }, "response": [ { "name": "If security token is not provided or user not authenticated.", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "[\n {\n \"code\": \"\",\n \"status\": \"\",\n \"description\": [\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n },\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n }\n ]\n },\n {\n \"code\": \"\",\n \"status\": \"\",\n \"description\": [\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n },\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n }\n ]\n }\n]" }, "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/transactiontypes", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "transactiontypes" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "If user doesn't have permission to access this resource.", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "[\n {\n \"code\": \"\",\n \"status\": \"\",\n \"description\": [\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n },\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n }\n ]\n },\n {\n \"code\": \"\",\n \"status\": \"\",\n \"description\": [\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n },\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n }\n ]\n }\n]" }, "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/transactiontypes", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "transactiontypes" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Validation of model fails.", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "[\n {\n \"code\": \"\",\n \"status\": \"\",\n \"description\": [\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n },\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n }\n ]\n },\n {\n \"code\": \"\",\n \"status\": \"\",\n \"description\": [\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n },\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n }\n ]\n }\n]" }, "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/transactiontypes", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "transactiontypes" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "If any network or client related error occurs.", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "[\n {\n \"code\": \"\",\n \"status\": \"\",\n \"description\": [\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n },\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n }\n ]\n },\n {\n \"code\": \"\",\n \"status\": \"\",\n \"description\": [\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n },\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n }\n ]\n }\n]" }, "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/transactiontypes", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "transactiontypes" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\"\n}" }, { "name": "The transaction types have been processed successfully", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "[\n {\n \"code\": \"\",\n \"status\": \"\",\n \"description\": [\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n },\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n }\n ]\n },\n {\n \"code\": \"\",\n \"status\": \"\",\n \"description\": [\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n },\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n }\n ]\n }\n]" }, "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/transactiontypes", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "transactiontypes" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"failed\": [\n {\n \"item\": {\n \"code\": \"\",\n \"status\": \"\",\n \"description\": [\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n },\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n }\n ]\n },\n \"message\": \"\"\n },\n {\n \"item\": {\n \"code\": \"\",\n \"status\": \"\",\n \"description\": [\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n },\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n }\n ]\n },\n \"message\": \"\"\n }\n ]\n}" } ] } ] }, { "name": "vatcodes", "item": [ { "name": "{code}", "item": [ { "name": "/vatcodes/:code", "request": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/vatcodes/:code", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "vatcodes", ":code" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization id of the organization to which the VAT code is related." }, { "key": "clientId", "value": "", "description": "(Required) Client id of the client to which the VAT code is related." }, { "key": "code", "value": "", "description": "(Required) The ERP code for the VAT code" } ] }, "description": "Gets a VAT code based on the ERP code." }, "response": [ { "name": "VAT code does not exist.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/vatcodes/:code", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "vatcodes", ":code" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" }, { "key": "code" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Validation of model fails.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/vatcodes/:code", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "vatcodes", ":code" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" }, { "key": "code" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "If security token is not provided or user not authenticated.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/vatcodes/:code", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "vatcodes", ":code" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" }, { "key": "code" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "The VAT code for the given client with requested code", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/vatcodes/:code", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "vatcodes", ":code" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" }, { "key": "code" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"\",\n \"status\": \"\",\n \"relations\": [\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n },\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n }\n ],\n \"vatRates\": [\n {\n \"ratePercentage\": \"\",\n \"validFrom\": \"\"\n },\n {\n \"ratePercentage\": \"\",\n \"validFrom\": \"\"\n }\n ],\n \"costRates\": [\n {\n \"ratePercentage\": \"\",\n \"validFrom\": \"\"\n },\n {\n \"ratePercentage\": \"\",\n \"validFrom\": \"\"\n }\n ],\n \"description\": [\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n },\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n }\n ]\n}" }, { "name": "If user doesn't have permission to access this resource.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/vatcodes/:code", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "vatcodes", ":code" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" }, { "key": "code" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "If any network or client related error occurs.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/vatcodes/:code", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "vatcodes", ":code" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" }, { "key": "code" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\"\n}" } ] }, { "name": "/vatcodes/:code", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/vatcodes/:code", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "vatcodes", ":code" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization id of the organization to which the VAT code is related." }, { "key": "clientId", "value": "", "description": "(Required) Client id of the client to which the VAT code is related." }, { "key": "code", "value": "", "description": "(Required) The ERP code of the VAT code to delete" } ] }, "description": "Delete a VAT code" }, "response": [ { "name": "If security token is not provided or user not authenticated.", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/vatcodes/:code", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "vatcodes", ":code" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" }, { "key": "code" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "If user doesn't have permission to access this resource.", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/vatcodes/:code", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "vatcodes", ":code" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" }, { "key": "code" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "If any network or client related error occurs.", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/vatcodes/:code", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "vatcodes", ":code" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" }, { "key": "code" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\"\n}" }, { "name": "The VAT code has been deleted successfully", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/vatcodes/:code", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "vatcodes", ":code" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" }, { "key": "code" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"\",\n \"status\": \"\",\n \"relations\": [\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n },\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n }\n ],\n \"vatRates\": [\n {\n \"ratePercentage\": \"\",\n \"validFrom\": \"\"\n },\n {\n \"ratePercentage\": \"\",\n \"validFrom\": \"\"\n }\n ],\n \"costRates\": [\n {\n \"ratePercentage\": \"\",\n \"validFrom\": \"\"\n },\n {\n \"ratePercentage\": \"\",\n \"validFrom\": \"\"\n }\n ],\n \"description\": [\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n },\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n }\n ]\n}" }, { "name": "Validation of model fails.", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/vatcodes/:code", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "vatcodes", ":code" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" }, { "key": "code" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] } ] }, { "name": "/vatcodes", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "[\n {\n \"code\": \"\",\n \"status\": \"\",\n \"relations\": [\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n },\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n }\n ],\n \"vatRates\": [\n {\n \"ratePercentage\": \"\",\n \"validFrom\": \"\"\n },\n {\n \"ratePercentage\": \"\",\n \"validFrom\": \"\"\n }\n ],\n \"costRates\": [\n {\n \"ratePercentage\": \"\",\n \"validFrom\": \"\"\n },\n {\n \"ratePercentage\": \"\",\n \"validFrom\": \"\"\n }\n ],\n \"description\": [\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n },\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n }\n ]\n },\n {\n \"code\": \"\",\n \"status\": \"\",\n \"relations\": [\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n },\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n }\n ],\n \"vatRates\": [\n {\n \"ratePercentage\": \"\",\n \"validFrom\": \"\"\n },\n {\n \"ratePercentage\": \"\",\n \"validFrom\": \"\"\n }\n ],\n \"costRates\": [\n {\n \"ratePercentage\": \"\",\n \"validFrom\": \"\"\n },\n {\n \"ratePercentage\": \"\",\n \"validFrom\": \"\"\n }\n ],\n \"description\": [\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n },\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n }\n ]\n }\n]" }, "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/vatcodes", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "vatcodes" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization id of the organizations to which the VAT codes is related." }, { "key": "clientId", "value": "", "description": "(Required) Client id of the client to which the VAT codes are related." } ] }, "description": "Inserts and updates VAT codes" }, "response": [ { "name": "If security token is not provided or user not authenticated.", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "[\n {\n \"code\": \"\",\n \"status\": \"\",\n \"relations\": [\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n },\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n }\n ],\n \"vatRates\": [\n {\n \"ratePercentage\": \"\",\n \"validFrom\": \"\"\n },\n {\n \"ratePercentage\": \"\",\n \"validFrom\": \"\"\n }\n ],\n \"costRates\": [\n {\n \"ratePercentage\": \"\",\n \"validFrom\": \"\"\n },\n {\n \"ratePercentage\": \"\",\n \"validFrom\": \"\"\n }\n ],\n \"description\": [\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n },\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n }\n ]\n },\n {\n \"code\": \"\",\n \"status\": \"\",\n \"relations\": [\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n },\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n }\n ],\n \"vatRates\": [\n {\n \"ratePercentage\": \"\",\n \"validFrom\": \"\"\n },\n {\n \"ratePercentage\": \"\",\n \"validFrom\": \"\"\n }\n ],\n \"costRates\": [\n {\n \"ratePercentage\": \"\",\n \"validFrom\": \"\"\n },\n {\n \"ratePercentage\": \"\",\n \"validFrom\": \"\"\n }\n ],\n \"description\": [\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n },\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n }\n ]\n }\n]" }, "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/vatcodes", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "vatcodes" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "The VAT codes have been processed successfully", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "[\n {\n \"code\": \"\",\n \"status\": \"\",\n \"relations\": [\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n },\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n }\n ],\n \"vatRates\": [\n {\n \"ratePercentage\": \"\",\n \"validFrom\": \"\"\n },\n {\n \"ratePercentage\": \"\",\n \"validFrom\": \"\"\n }\n ],\n \"costRates\": [\n {\n \"ratePercentage\": \"\",\n \"validFrom\": \"\"\n },\n {\n \"ratePercentage\": \"\",\n \"validFrom\": \"\"\n }\n ],\n \"description\": [\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n },\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n }\n ]\n },\n {\n \"code\": \"\",\n \"status\": \"\",\n \"relations\": [\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n },\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n }\n ],\n \"vatRates\": [\n {\n \"ratePercentage\": \"\",\n \"validFrom\": \"\"\n },\n {\n \"ratePercentage\": \"\",\n \"validFrom\": \"\"\n }\n ],\n \"costRates\": [\n {\n \"ratePercentage\": \"\",\n \"validFrom\": \"\"\n },\n {\n \"ratePercentage\": \"\",\n \"validFrom\": \"\"\n }\n ],\n \"description\": [\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n },\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n }\n ]\n }\n]" }, "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/vatcodes", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "vatcodes" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"failed\": [\n {\n \"item\": {\n \"code\": \"\",\n \"status\": \"\",\n \"relations\": [\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n },\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n }\n ],\n \"vatRates\": [\n {\n \"ratePercentage\": \"\",\n \"validFrom\": \"\"\n },\n {\n \"ratePercentage\": \"\",\n \"validFrom\": \"\"\n }\n ],\n \"costRates\": [\n {\n \"ratePercentage\": \"\",\n \"validFrom\": \"\"\n },\n {\n \"ratePercentage\": \"\",\n \"validFrom\": \"\"\n }\n ],\n \"description\": [\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n },\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n }\n ]\n },\n \"message\": \"\"\n },\n {\n \"item\": {\n \"code\": \"\",\n \"status\": \"\",\n \"relations\": [\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n },\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n }\n ],\n \"vatRates\": [\n {\n \"ratePercentage\": \"\",\n \"validFrom\": \"\"\n },\n {\n \"ratePercentage\": \"\",\n \"validFrom\": \"\"\n }\n ],\n \"costRates\": [\n {\n \"ratePercentage\": \"\",\n \"validFrom\": \"\"\n },\n {\n \"ratePercentage\": \"\",\n \"validFrom\": \"\"\n }\n ],\n \"description\": [\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n },\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n }\n ]\n },\n \"message\": \"\"\n }\n ]\n}" }, { "name": "If user doesn't have permission to access this resource.", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "[\n {\n \"code\": \"\",\n \"status\": \"\",\n \"relations\": [\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n },\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n }\n ],\n \"vatRates\": [\n {\n \"ratePercentage\": \"\",\n \"validFrom\": \"\"\n },\n {\n \"ratePercentage\": \"\",\n \"validFrom\": \"\"\n }\n ],\n \"costRates\": [\n {\n \"ratePercentage\": \"\",\n \"validFrom\": \"\"\n },\n {\n \"ratePercentage\": \"\",\n \"validFrom\": \"\"\n }\n ],\n \"description\": [\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n },\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n }\n ]\n },\n {\n \"code\": \"\",\n \"status\": \"\",\n \"relations\": [\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n },\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n }\n ],\n \"vatRates\": [\n {\n \"ratePercentage\": \"\",\n \"validFrom\": \"\"\n },\n {\n \"ratePercentage\": \"\",\n \"validFrom\": \"\"\n }\n ],\n \"costRates\": [\n {\n \"ratePercentage\": \"\",\n \"validFrom\": \"\"\n },\n {\n \"ratePercentage\": \"\",\n \"validFrom\": \"\"\n }\n ],\n \"description\": [\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n },\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n }\n ]\n }\n]" }, "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/vatcodes", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "vatcodes" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Validation of model fails.", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "[\n {\n \"code\": \"\",\n \"status\": \"\",\n \"relations\": [\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n },\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n }\n ],\n \"vatRates\": [\n {\n \"ratePercentage\": \"\",\n \"validFrom\": \"\"\n },\n {\n \"ratePercentage\": \"\",\n \"validFrom\": \"\"\n }\n ],\n \"costRates\": [\n {\n \"ratePercentage\": \"\",\n \"validFrom\": \"\"\n },\n {\n \"ratePercentage\": \"\",\n \"validFrom\": \"\"\n }\n ],\n \"description\": [\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n },\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n }\n ]\n },\n {\n \"code\": \"\",\n \"status\": \"\",\n \"relations\": [\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n },\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n }\n ],\n \"vatRates\": [\n {\n \"ratePercentage\": \"\",\n \"validFrom\": \"\"\n },\n {\n \"ratePercentage\": \"\",\n \"validFrom\": \"\"\n }\n ],\n \"costRates\": [\n {\n \"ratePercentage\": \"\",\n \"validFrom\": \"\"\n },\n {\n \"ratePercentage\": \"\",\n \"validFrom\": \"\"\n }\n ],\n \"description\": [\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n },\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n }\n ]\n }\n]" }, "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/vatcodes", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "vatcodes" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "If any network or client related error occurs.", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "[\n {\n \"code\": \"\",\n \"status\": \"\",\n \"relations\": [\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n },\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n }\n ],\n \"vatRates\": [\n {\n \"ratePercentage\": \"\",\n \"validFrom\": \"\"\n },\n {\n \"ratePercentage\": \"\",\n \"validFrom\": \"\"\n }\n ],\n \"costRates\": [\n {\n \"ratePercentage\": \"\",\n \"validFrom\": \"\"\n },\n {\n \"ratePercentage\": \"\",\n \"validFrom\": \"\"\n }\n ],\n \"description\": [\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n },\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n }\n ]\n },\n {\n \"code\": \"\",\n \"status\": \"\",\n \"relations\": [\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n },\n {\n \"type\": \"\",\n \"typeCode\": \"\",\n \"code\": \"\",\n \"operation\": \"\"\n }\n ],\n \"vatRates\": [\n {\n \"ratePercentage\": \"\",\n \"validFrom\": \"\"\n },\n {\n \"ratePercentage\": \"\",\n \"validFrom\": \"\"\n }\n ],\n \"costRates\": [\n {\n \"ratePercentage\": \"\",\n \"validFrom\": \"\"\n },\n {\n \"ratePercentage\": \"\",\n \"validFrom\": \"\"\n }\n ],\n \"description\": [\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n },\n {\n \"description\": \"\",\n \"languageCode\": \"\"\n }\n ]\n }\n]" }, "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients/{{clientId}}/vatcodes", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients", "{{clientId}}", "vatcodes" ], "variable": [ { "key": "organizationId" }, { "key": "clientId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\"\n}" } ] } ] } ] }, { "name": "/api/v1.0/organizations/{{organizationId}}/clients", "request": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) The organization id to which the clients belong." } ] }, "description": "Gets all available clients." }, "response": [ { "name": "No clients are available for the requested organization", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients" ], "variable": [ { "key": "organizationId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "If any network or client related error occurs.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients" ], "variable": [ { "key": "organizationId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\"\n}" }, { "name": "If user doesn't have permission to access this resource.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients" ], "variable": [ { "key": "organizationId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "If the request is malformed", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients" ], "variable": [ { "key": "organizationId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "If security token is not provided or user not authenticated.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients" ], "variable": [ { "key": "organizationId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "The available clients for the requested organization", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/clients", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "clients" ], "variable": [ { "key": "organizationId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"id\": \"\",\n \"name\": \"\",\n \"organizationId\": \"\",\n \"externalCode\": \"\",\n \"apiKey\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"organizationId\": \"\",\n \"externalCode\": \"\",\n \"apiKey\": \"\"\n }\n]" } ] } ] }, { "name": "settings", "item": [ { "name": "/api/v1.0/organizations/{{organizationId}}/settings", "request": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/settings", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "settings" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) The organization id of the organization to get settings for." } ] }, "description": "Gets all settings for a given organization." }, "response": [ { "name": "No settings were found for the given organization", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/settings", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "settings" ], "variable": [ { "key": "organizationId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "If user doesn't have permission to access this resource.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/settings", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "settings" ], "variable": [ { "key": "organizationId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "The settings for the organization was fetched successfully", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/settings", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "settings" ], "variable": [ { "key": "organizationId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"settingKey\": \"\",\n \"dataType\": \"\",\n \"stringValue\": \"\",\n \"integerValue\": \"\",\n \"booleanValue\": \"\",\n \"decimalValue\": \"\",\n \"dateTimeValue\": \"\",\n \"guidValue\": \"\"\n },\n {\n \"settingKey\": \"\",\n \"dataType\": \"\",\n \"stringValue\": \"\",\n \"integerValue\": \"\",\n \"booleanValue\": \"\",\n \"decimalValue\": \"\",\n \"dateTimeValue\": \"\",\n \"guidValue\": \"\"\n }\n]" }, { "name": "If the request is malformed", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/settings", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "settings" ], "variable": [ { "key": "organizationId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "If security token is not provided or user not authenticated.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/settings", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "settings" ], "variable": [ { "key": "organizationId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "If any network or client related error occurs.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/settings", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "settings" ], "variable": [ { "key": "organizationId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\"\n}" } ] }, { "name": "/api/v1.0/organizations/{{organizationId}}/settings", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"settingKey\": \"\",\n \"dataType\": \"\",\n \"stringValue\": \"\",\n \"integerValue\": \"\",\n \"booleanValue\": \"\",\n \"decimalValue\": \"\",\n \"dateTimeValue\": \"\",\n \"guidValue\": \"\"\n}" }, "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/settings", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "settings" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) The organization id of the organization to add or update the setting for." } ] }, "description": "Adds or updates a setting for a given organization." }, "response": [ { "name": "If security token is not provided or user not authenticated.", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"settingKey\": \"\",\n \"dataType\": \"\",\n \"stringValue\": \"\",\n \"integerValue\": \"\",\n \"booleanValue\": \"\",\n \"decimalValue\": \"\",\n \"dateTimeValue\": \"\",\n \"guidValue\": \"\"\n}" }, "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/settings", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "settings" ], "variable": [ { "key": "organizationId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "The setting was added or updated successfully", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"settingKey\": \"\",\n \"dataType\": \"\",\n \"stringValue\": \"\",\n \"integerValue\": \"\",\n \"booleanValue\": \"\",\n \"decimalValue\": \"\",\n \"dateTimeValue\": \"\",\n \"guidValue\": \"\"\n}" }, "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/settings", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "settings" ], "variable": [ { "key": "organizationId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"settingKey\": \"\",\n \"dataType\": \"\",\n \"stringValue\": \"\",\n \"integerValue\": \"\",\n \"booleanValue\": \"\",\n \"decimalValue\": \"\",\n \"dateTimeValue\": \"\",\n \"guidValue\": \"\"\n}" }, { "name": "If any network or client related error occurs.", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"settingKey\": \"\",\n \"dataType\": \"\",\n \"stringValue\": \"\",\n \"integerValue\": \"\",\n \"booleanValue\": \"\",\n \"decimalValue\": \"\",\n \"dateTimeValue\": \"\",\n \"guidValue\": \"\"\n}" }, "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/settings", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "settings" ], "variable": [ { "key": "organizationId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\"\n}" }, { "name": "If the request is malformed", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"settingKey\": \"\",\n \"dataType\": \"\",\n \"stringValue\": \"\",\n \"integerValue\": \"\",\n \"booleanValue\": \"\",\n \"decimalValue\": \"\",\n \"dateTimeValue\": \"\",\n \"guidValue\": \"\"\n}" }, "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/settings", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "settings" ], "variable": [ { "key": "organizationId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "If user doesn't have permission to access this resource.", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"settingKey\": \"\",\n \"dataType\": \"\",\n \"stringValue\": \"\",\n \"integerValue\": \"\",\n \"booleanValue\": \"\",\n \"decimalValue\": \"\",\n \"dateTimeValue\": \"\",\n \"guidValue\": \"\"\n}" }, "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/settings", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "settings" ], "variable": [ { "key": "organizationId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] }, { "name": "/api/v1.0/organizations/{{organizationId}}/settings/:settingKey", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/settings/:settingKey", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "settings", ":settingKey" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) The organization id of the organization the setting is connected to." }, { "key": "settingKey", "value": "", "description": "(Required) The key of the setting to remove from the organization." } ] }, "description": "Deletes a setting for a given organization." }, "response": [ { "name": "If security token is not provided or user not authenticated.", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/settings/:settingKey", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "settings", ":settingKey" ], "variable": [ { "key": "organizationId" }, { "key": "settingKey" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "The setting was deleted successfully", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/settings/:settingKey", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "settings", ":settingKey" ], "variable": [ { "key": "organizationId" }, { "key": "settingKey" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"settingKey\": \"\",\n \"dataType\": \"\",\n \"stringValue\": \"\",\n \"integerValue\": \"\",\n \"booleanValue\": \"\",\n \"decimalValue\": \"\",\n \"dateTimeValue\": \"\",\n \"guidValue\": \"\"\n}" }, { "name": "If any network or client related error occurs.", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/settings/:settingKey", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "settings", ":settingKey" ], "variable": [ { "key": "organizationId" }, { "key": "settingKey" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\"\n}" }, { "name": "If user doesn't have permission to access this resource.", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/settings/:settingKey", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "settings", ":settingKey" ], "variable": [ { "key": "organizationId" }, { "key": "settingKey" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "If the request is malformed", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations/{{organizationId}}/settings/:settingKey", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations", "{{organizationId}}", "settings", ":settingKey" ], "variable": [ { "key": "organizationId" }, { "key": "settingKey" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] } ] } ] }, { "name": "/api/v1.0/organizations", "request": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations" ] }, "description": "Gets all available organizations." }, "response": [ { "name": "If any network or client related error occurs.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"statusCode\": \"\",\n \"message\": \"\"\n}" }, { "name": "If the request is malformed", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "No organizations are available", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations" ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "If user doesn't have permission to access this resource.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "If security token is not provided or user not authenticated.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "The available organizations", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{API}}/api/v1.0/organizations", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "organizations" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n]" } ] } ] }, { "name": "/api/v1.0/settings/settingkeys", "request": { "method": "POST", "header": [], "url": { "raw": "{{API}}/api/v1.0/settings/settingkeys", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "settings", "settingkeys" ] }, "description": "Gets all the available setting keys." }, "response": [ { "name": "All available setting keys", "originalRequest": { "method": "POST", "header": [], "url": { "raw": "{{API}}/api/v1.0/settings/settingkeys", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "settings", "settingkeys" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"key\": \"\",\n \"description\": \"\",\n \"validForClient\": \"\",\n \"validForOrganization\": \"\",\n \"dataType\": \"\"\n },\n {\n \"key\": \"\",\n \"description\": \"\",\n \"validForClient\": \"\",\n \"validForOrganization\": \"\",\n \"dataType\": \"\"\n }\n]" }, { "name": "If security token is not provided or user not authenticated.", "originalRequest": { "method": "POST", "header": [], "url": { "raw": "{{API}}/api/v1.0/settings/settingkeys", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "settings", "settingkeys" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Forbidden", "originalRequest": { "method": "POST", "header": [], "url": { "raw": "{{API}}/api/v1.0/settings/settingkeys", "host": [ "{{API}}" ], "path": [ "api", "v1.0", "settings", "settingkeys" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] } ] } ], "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{Token}}", "type": "string" } ] }, "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "" ] } }, { "listen": "test", "script": { "type": "text/javascript", "exec": [ "" ] } } ], "variable": [ { "key": "baseUrl", "value": "/" } ] }